1
0
mirror of synced 2026-01-06 06:02:35 -05:00

Merge pull request #31504 from github/repo-sync

Repo sync
This commit is contained in:
docs-bot
2024-02-07 08:32:45 -08:00
committed by GitHub
48 changed files with 164 additions and 108 deletions

View File

@@ -190,7 +190,7 @@ Windows virtual machines are configured to run as administrators with User Accou
## IP addresses
To get a list of IP address ranges that {% data variables.product.prodname_actions %} uses for {% data variables.product.prodname_dotcom %}-hosted runners, you can use the {% data variables.product.prodname_dotcom %} REST API. For more information, see the `actions` key in the response of the "[AUTOTITLE](/rest/meta#get-github-meta-information)" endpoint.
To get a list of IP address ranges that {% data variables.product.prodname_actions %} uses for {% data variables.product.prodname_dotcom %}-hosted runners, you can use the {% data variables.product.prodname_dotcom %} REST API. For more information, see the `actions` key in the response of the `GET /meta` endpoint. For more information, see "[AUTOTITLE](/rest/meta#get-github-meta-information)."
Windows and Ubuntu runners are hosted in Azure and subsequently have the same IP address ranges as the Azure datacenters. macOS runners are hosted in {% data variables.product.prodname_dotcom %}'s own macOS cloud.

View File

@@ -41,7 +41,7 @@ Some events have multiple activity types. For these events, you can specify whic
{% data reusables.actions.branch-requirement %}
Runs your workflow when branch protection rules in the workflow repository are changed. For more information about branch protection rules, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)." For information about the branch protection rule APIs, see "[AUTOTITLE](/graphql/reference/objects#branchprotectionrule)" in the GraphQL API documentation or "[AUTOTITLE](/rest/branches)" in the REST API documentation.
Runs your workflow when branch protection rules in the workflow repository are changed. For more information about branch protection rules, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)." For information about the branch protection rule APIs, see "[AUTOTITLE](/graphql/reference/objects#branchprotectionrule)" in the GraphQL API documentation or "[AUTOTITLE](/rest/branches)."
For example, you can run a workflow when a branch protection rule has been `created` or `deleted`:
@@ -65,7 +65,7 @@ on:
{% data reusables.actions.branch-requirement %}
Runs your workflow when activity related to a check run occurs. A check run is an individual test that is part of a check suite. For information, see "[AUTOTITLE](/rest/guides/using-the-rest-api-to-interact-with-checks)." For information about the check run APIs, see "[AUTOTITLE](/graphql/reference/objects#checkrun)" in the GraphQL API documentation or "[AUTOTITLE](/rest/checks#runs)" in the REST API documentation.
Runs your workflow when activity related to a check run occurs. A check run is an individual test that is part of a check suite. For information, see "[AUTOTITLE](/rest/guides/using-the-rest-api-to-interact-with-checks)." For information about the check run APIs, see "[AUTOTITLE](/graphql/reference/objects#checkrun)" in the GraphQL API documentation or "[AUTOTITLE](/rest/checks#runs)."
For example, you can run a workflow when a check run has been `rerequested` or `completed`.
@@ -95,7 +95,7 @@ on:
{% endnote %}
Runs your workflow when check suite activity occurs. A check suite is a collection of the check runs created for a specific commit. Check suites summarize the status and conclusion of the check runs that are in the suite. For information, see "[AUTOTITLE](/rest/guides/using-the-rest-api-to-interact-with-checks)." For information about the check suite APIs, see "[AUTOTITLE](/graphql/reference/objects#checksuite)" in the GraphQL API documentation or "[AUTOTITLE](/rest/checks#suites)" in the REST API documentation.
Runs your workflow when check suite activity occurs. A check suite is a collection of the check runs created for a specific commit. Check suites summarize the status and conclusion of the check runs that are in the suite. For information, see "[AUTOTITLE](/rest/guides/using-the-rest-api-to-interact-with-checks)." For information about the check suite APIs, see "[AUTOTITLE](/graphql/reference/objects#checksuite)" in the GraphQL API documentation or "[AUTOTITLE](/rest/checks#suites)."
For example, you can run a workflow when a check suite has been `completed`.
@@ -1257,7 +1257,7 @@ jobs:
{% data reusables.actions.branch-requirement %}
Runs your workflow when the workflow's repository is starred. For information about the pull request APIs, see "[AUTOTITLE](/graphql/reference/mutations#addstar)" in the GraphQL API documentation or "[AUTOTITLE](/rest/activity#starring)" in the REST API documentation.
Runs your workflow when the workflow's repository is starred. For information about the pull request APIs, see "[AUTOTITLE](/graphql/reference/mutations#addstar)" in the GraphQL API documentation or "[AUTOTITLE](/rest/activity#starring)."
For example, you can run a workflow when someone stars a repository, which is the `started` activity type for a watch event.

View File

@@ -254,7 +254,7 @@ To stream audit logs to Splunk's HTTP Event Collector (HEC) endpoint you must ma
{% endnote %}
{% ifversion ghec %}
To get a list of IP address ranges that {% data variables.product.prodname_dotcom %} uses for connections to the HEC endpoint, you can use the REST API. The `meta` endpoint for {% data variables.product.product_name %} includes a `hooks` key with a list of the IP addresses. For more information, see "[Meta](/rest/meta/meta#get-github-enterprise-cloud-meta-information)" in the REST API documentation.
To get a list of IP address ranges that {% data variables.product.prodname_dotcom %} uses for connections to the HEC endpoint, you can use the REST API. The `meta` endpoint for {% data variables.product.product_name %} includes a `hooks` key with a list of the IP addresses. For more information, see "[AUTOTITLE](/rest/meta/meta#get-github-enterprise-cloud-meta-information)."
{% endif %}
{% data reusables.enterprise.navigate-to-log-streaming-tab %}

View File

@@ -86,7 +86,7 @@ The `$GITHUB_VIA` variable is available in the pre-receive hook environment when
| :- | :- | :- |
| <pre>auto-merge deployment api</pre> | Automatic merge of the base branch via a deployment created with the API | "[AUTOTITLE](/rest/deployments#create-a-deployment)" in the REST API documentation |
| <pre>blob#save</pre> | Change to a file's contents in the web interface | "[AUTOTITLE](/repositories/working-with-files/managing-files/editing-files)" |
| <pre>branch merge api</pre> | Merge of a branch via the API | "[AUTOTITLE](/rest/branches#merge-a-branch)" in the REST API documentation |
| <pre>branch merge api</pre> | Merge of a branch via the API | "[AUTOTITLE](/rest/branches#merge-a-branch)" |
| <pre>branches page delete button</pre> | Deletion of a branch in the web interface | "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository#deleting-a-branch)" |
| <pre>git refs create api</pre> | Creation of a ref via the API | "[AUTOTITLE](/rest/git#create-a-reference)" in the REST API documentation |
| <pre>git refs delete api</pre> | Deletion of a ref via the API | "[AUTOTITLE](/rest/git#delete-a-reference)" in the REST API documentation |

View File

@@ -49,7 +49,7 @@ Checks include check runs, check suites, and commit statuses.
1. When someone pushes code to the repository, {% data variables.product.prodname_dotcom %} automatically sends the `check_suite` event with an action of `requested` to all {% data variables.product.prodname_github_apps %} installed on the repository that have the `checks:write` permission. This event lets the apps know that code was pushed to the repository, and that {% data variables.product.prodname_dotcom %} has automatically created a new check suite.
1. When your app receives this event, it can add check runs to that suite.
1. Your check runs can include annotations that are displayed on specific lines of code. Annotations are visible in the **Checks** tab. When you create an annotation for a file that is part of the pull request, the annotations are also shown in the **Files changed** tab. For more information, see the `annotations` object in the "[AUTOTITLE](/rest/checks/runs#create-a-check-run)" documentation.
1. Your check runs can include annotations that are displayed on specific lines of code. Annotations are visible in the **Checks** tab. When you create an annotation for a file that is part of the pull request, the annotations are also shown in the **Files changed** tab. For more information, see the `annotations` object in "[AUTOTITLE](/rest/checks/runs#create-a-check-run)."
For more information about checks, see "[AUTOTITLE](/rest/checks)" and "[AUTOTITLE](/rest/guides/using-the-rest-api-to-interact-with-checks)."
@@ -662,7 +662,7 @@ In the code block that starts with `helpers do`, where it says `# ADD CREATE_CHE
end
```
This code calls the "[AUTOTITLE](/rest/checks#create-a-check-run)" endpoint using the Octokit [create_check_run method](https://msp-greg.github.io/octokit/Octokit/Client/Checks.html#create_check_run-instance_method).
This code calls the `POST /repos/{owner}/{repo}/check-runs` endpoint using the Octokit [create_check_run method](https://msp-greg.github.io/octokit/Octokit/Client/Checks.html#create_check_run-instance_method). For more information about the endpoint, see "[AUTOTITLE](/rest/checks#create-a-check-run)."
To create a check run, only two input parameters are required: `name` and `head_sha`. In this code, we name the check run "Octo RuboCop," because we'll use RuboCop to implement the CI test later in the tutorial. But you can choose any name you'd like for the check run. For more information about RuboCop, see the [RuboCop documentation](https://docs.rubocop.org/rubocop/index.html).
@@ -749,7 +749,7 @@ In the code block that starts with `helpers do`, where it says `# ADD INITIATE_C
end
```
The code above calls the "[Update a check run](/rest/checks#update-a-check-run)" endpoint using the [`update_check_run` Octokit method](https://msp-greg.github.io/octokit/Octokit/Client/Checks.html#update_check_run-instance_method), and updates the check run that you already created.
The code above calls the `PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}` endpoint using the [`update_check_run` Octokit method](https://msp-greg.github.io/octokit/Octokit/Client/Checks.html#update_check_run-instance_method), and updates the check run that you already created. For more information about the endpoint, see "[AUTOTITLE](/rest/checks#update-a-check-run)."
Here's what this code is doing. First, it updates the check run's status to `in_progress` and implicitly sets the `started_at` time to the current time. In Part 2 of this tutorial, you'll add code that kicks off a real CI test under `***** RUN A CI TEST *****`. For now, you'll leave that section as a placeholder, so the code that follows it will just simulate that the CI process succeeds and all tests pass. Finally, the code updates the status of the check run again to `completed`.
@@ -998,7 +998,7 @@ The following steps will show you how to test that the code works and view the e
The `@output` variable contains the parsed JSON results of the RuboCop report. As shown in the example output in the previous step, the results contain a `summary` section that your code can use to quickly determine if there are any errors. The following code will set the check run conclusion to `success` when there are no reported errors. RuboCop reports errors for each file in the `files` array, so if there are errors, you'll need to extract some data from the file object.
The REST API endpoints to manage check runs allow you to create annotations for specific lines of code. When you create or update a check run, you can add annotations. In this tutorial you will update the check run with annotations, using the "[Update a check run](/rest/checks/runs#update-a-check-run)" endpoint.
The REST API endpoints to manage check runs allow you to create annotations for specific lines of code. When you create or update a check run, you can add annotations. In this tutorial you will update the check run with annotations, using the `PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}` endpoint. For more information about the endpoint, see "[AUTOTITLE](/rest/checks/runs#update-a-check-run)."
The API limits the number of annotations to a maximum of 50 per request. To create more than 50 annotations, you will have to make multiple requests to the "Update a check run" endpoint. For example, to create 105 annotations you would need to make three separate requests to the API. The first two requests would each have 50 annotations, and the third request would include the five remaining annotations. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run.

View File

@@ -86,7 +86,7 @@ Name | Description
**`workflow`** | Grants the ability to add and update {% data variables.product.prodname_actions %} workflow files. Workflow files can be committed without this scope if the same file (with both the same path and contents) exists on another branch in the same repository. Workflow files can expose `GITHUB_TOKEN` which may have a different set of scopes. For more information, see "[AUTOTITLE](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token)."{% ifversion not fpt %}
**`admin:enterprise`** | Gives full control of enterprise functionality. For more information, see "[AUTOTITLE](/graphql/guides/managing-enterprise-accounts)" in the GraphQL API documentation.<br><br>Includes `manage_runners:enterprise`{% ifversion ghec or ghes %}, `manage_billing:enterprise`,{% endif %} and `read:enterprise`.
&emsp;`manage_runners:enterprise` | Gives full control over self-hosted runners within the enterprise. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)." {% ifversion ghec or ghes %}
&emsp;`manage_billing:enterprise` | Read and write enterprise billing data. For more information, see "[AUTOTITLE](/rest/billing)" in the REST API documentation. {% endif %}
&emsp;`manage_billing:enterprise` | Read and write enterprise billing data. For more information, see "[AUTOTITLE](/rest/billing)." {% endif %}
&emsp;`read:enterprise` | Read all data on an enterprise profile. Does not include profile data of enterprise members or organizations.{% endif %}{% ifversion read-audit-scope %}
**`read:audit_log`** | Read audit log data.{% endif %}
{% note %}

View File

@@ -137,7 +137,7 @@ You can retrieve {% data variables.product.prodname_advanced_security %} usage i
{% ifversion ghec %}
For organization-level data, use the `/orgs/{org}/settings/billing/advanced-security` endpoint. For more information, see "[AUTOTITLE](/rest/billing#get-github-advanced-security-active-committers-for-an-organization)" in the {% data variables.product.prodname_dotcom %} REST API documentation.
For organization-level data, use the `/orgs/{org}/settings/billing/advanced-security` endpoint. For more information, see "[AUTOTITLE](/rest/billing#get-github-advanced-security-active-committers-for-an-organization)."
{% endif %}

View File

@@ -620,7 +620,7 @@ registries:
If you are running Nexus behind a reverse proxy, you need to ensure that the server is accessible using an Auth token by using `curl -v -H 'Authorization: Bearer <token>' 'https://<nexus-repo-url>/repository/<repo-name>/@<scope>%2<package>'`. For more information, see [Run Behind a Reverse Proxy](https://help.sonatype.com/repomanager3/planning-your-implementation/run-behind-a-reverse-proxy) in the Sonatype documentation.
If you are restricting which IPs can reach your Nexus host, you need to add the {% data variables.product.prodname_dependabot %} IPs to the allowlist.
- You can find the IP addresses {% data variables.product.prodname_dependabot %} uses to access the registry in the meta API endpoint, under the dependabot key. For more information, see "[Meta](/rest/meta)" in the Meta API documentation.
- You can find the IP addresses {% data variables.product.prodname_dependabot %} uses to access the registry in the meta API endpoint, under the dependabot key. For more information, see "[AUTOTITLE](/rest/meta)."
- These are the current IPs:
- "18.213.123.130/32"
- "3.217.79.163/32"

View File

@@ -47,7 +47,7 @@ These third party solutions include:
### Allowlisting private resources for codespaces
While {% data variables.product.prodname_dotcom %} publishes IP ranges for several products on its Meta API, IP addresses for codespaces are dynamically assigned, meaning your codespace is not guaranteed to have the same IP address day to day. For more information about the Meta API, see "[AUTOTITLE](/rest/meta/meta)."
While {% data variables.product.prodname_dotcom %} publishes IP ranges for several products on its Meta API, IP addresses for codespaces are dynamically assigned, meaning your codespace is not guaranteed to have the same IP address day to day. For more information, see "[AUTOTITLE](/rest/meta/meta)."
Allowlisting an entire IP range would give overly broad access to all codespaces (including users not affiliated with your codespaces), so for this reason codespace creation is disabled if you enable IP allow lists. For more information, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization#enabling-allowed-ip-addresses)."

View File

@@ -32,7 +32,7 @@ Sometimes you may not be able to access a codespace from your browser. If this h
Check that you have a stable internet connection and that your company network is not blocking the connection. If possible, check logging for rejected connections on your device.
If you see rejected connections, make sure the domains documented by the `/meta` REST API endpoint are not blocked by your firewall. For more information, see "[AUTOTITLE](/rest/meta/meta?apiVersion=2022-11-28#get-github-meta-information)."
If you see rejected connections, make sure the domains documented by the `/meta` REST API endpoint are not blocked by your firewall. For more information, see "[AUTOTITLE](/rest/meta/meta#get-github-meta-information)."
To get the list of domains required by {% data variables.product.prodname_github_codespaces %}, execute the following command using {% data variables.product.prodname_cli %}:

View File

@@ -21,4 +21,4 @@ You can use the REST API to retrieve a list of {% data variables.product.company
{% endwarning %}
For more information, see "[AUTOTITLE](/rest/meta)" in the REST API documentation.
For more information, see "[AUTOTITLE](/rest/meta)."

View File

@@ -94,7 +94,7 @@ The starter workflows use a deployment environment called `github-pages`. If you
{% ifversion fpt or ghec %}
{% 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 "[AUTOTITLE](/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).
**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 "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site#configuring-a-subdomain)" and "[AUTOTITLE](/rest/pages#update-information-about-a-github-pages-site)."
{% endnote %}
{% endif %}

View File

@@ -1,5 +1,7 @@
---
title: Events
title: REST API endpoints for events
shortTitle: Events
allowTitleToDifferFromFilename: true
intro: >-
Use the REST API to interact with {% data variables.product.prodname_dotcom %}
events.

View File

@@ -1,5 +1,7 @@
---
title: Feeds
title: REST API endpoints for feeds
shortTitle: Feeds
allowTitleToDifferFromFilename: true
intro: >-
Use the REST API to interact with {% data variables.product.prodname_dotcom %}
feeds.
@@ -33,11 +35,11 @@ HTTP/2 200
```xml
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:media="http://search.yahoo.com/mrss/"
<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:media="http://search.yahoo.com/mrss/"
xml:lang="en-US">
<id>tag:github.com,2008:/security-advisories</id>
<link rel="self" type="application/atom+xml"
<link rel="self" type="application/atom+xml"
href="https://github.com/security-advisories.atom"/>
<title>GitHub Security Advisory Feed</title>
<author>
@@ -48,17 +50,17 @@ xml:lang="en-US">
<id>tag:github.com,2008:GHSA-abcd-12ab-23cd</id>
<published>2018-07-26T15:14:52Z</published>
<updated>2019-01-14T19:34:52Z</updated>
<title type="html">[GHSA-abcd-12ab-23cd] Moderate
<title type="html">[GHSA-abcd-12ab-23cd] Moderate
severity vulnerability that affects Octoapp</title>
<category term="NPM"/>
<content type="html">
&lt;p&gt;Octoapp node module before 4.17.5 suffers
from a Modification of Assumed-Immutable Data (MAID)
vulnerability via defaultsDeep, merge, and mergeWith
functions, which allows a malicious user to modify
the prototype of &quot;Object&quot; via
&lt;strong&gt;proto&lt;/strong&gt;, causing the
addition or modification of an existing property
&lt;p&gt;Octoapp node module before 4.17.5 suffers
from a Modification of Assumed-Immutable Data (MAID)
vulnerability via defaultsDeep, merge, and mergeWith
functions, which allows a malicious user to modify
the prototype of &quot;Object&quot; via
&lt;strong&gt;proto&lt;/strong&gt;, causing the
addition or modification of an existing property
that will exist on all objects.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Affected Packages&lt;/strong&gt;&lt;/p&gt;

View File

@@ -1,5 +1,7 @@
---
title: Activity
title: REST API endpoints for activity
shortTitle: Activity
allowTitleToDifferFromFilename: true
intro: 'Use the REST API to list events and feeds and manage notifications, starring, and watching.'
redirect_from:
- /v3/activity

View File

@@ -1,5 +1,7 @@
---
title: Notifications
title: REST API endpoints for notifications
shortTitle: Notifications
allowTitleToDifferFromFilename: true
intro: >-
Use the REST API to manage {% data variables.product.product_name %}
notifications.

View File

@@ -1,6 +1,8 @@
---
title: Starring
title: REST API endpoints for starring
shortTitle: Starring
intro: Use the REST API to bookmark a repository.
allowTitleToDifferFromFilename: true
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
@@ -21,7 +23,7 @@ In August 2012, we [changed the way watching
works](https://github.com/blog/1204-notifications-stars) on {% data variables.product.prodname_dotcom %}. Some API
client applications may still be using the original "watcher" endpoints for accessing
this data. You should now use the "star" endpoints instead (described
below). For more information, see the REST API "[AUTOTITLE](/rest/activity/watching)" documentation and the [Watcher API changelog post](https://developer.github.com/changes/2012-09-05-watcher-api/).
below). For more information, see "[AUTOTITLE](/rest/activity/watching)" and the [changelog post](https://developer.github.com/changes/2012-09-05-watcher-api/).
In responses from the REST API, `watchers`, `watchers_count`, and `stargazers_count` correspond to the number of users that have starred a repository, whereas `subscribers_count` corresponds to the number of watchers.

View File

@@ -1,6 +1,8 @@
---
title: Watching
title: REST API endpoints for watching
shortTitle: Watching
intro: Use the REST API to subscribe to notifications for activity in a repository.
allowTitleToDifferFromFilename: true
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
@@ -20,7 +22,7 @@ You can use the REST API to subscribe to notifications for activity in a reposit
In August 2012, we [changed the way watching
works](https://github.com/blog/1204-notifications-stars) on {% data variables.product.prodname_dotcom %}. Some API
client applications may still be using the original "watcher" endpoints for accessing
this data. You should now use the "star" endpoints instead. For more information, see the REST API "[AUTOTITLE](/rest/activity/starring)" documentation and the [Watcher API Change post](https://developer.github.com/changes/2012-09-05-watcher-api/).
this data. You should now use the "star" endpoints instead. For more information, "[AUTOTITLE](/rest/activity/starring)" and the [changelog post](https://developer.github.com/changes/2012-09-05-watcher-api/).
In responses from the REST API, `subscribers_count` corresponds to the number of watchers, whereas `watchers`, `watchers_count`, and `stargazers_count` correspond to the number of users that have starred a repository.

View File

@@ -1,5 +1,5 @@
---
title: Enterprise announcement banners
title: REST API endpoints for enterprise announcement banners
shortTitle: Enterprise
intro: >-
The Enterprise Announcement Banners API allows you to get, set, and remove the

View File

@@ -1,5 +1,7 @@
---
title: Announcement Banners
title: REST API endpoints for announcement banners
shortTitle: Announcement banners
allowTitleToDifferFromFilename: true
intro: 'The Announcement Banners API enables you to view, create, and remove an announcement banner for your enterprise or organization.'
versions:
ghec: '*'

View File

@@ -1,5 +1,5 @@
---
title: Organization announcement banners
title: REST API endpoints for organization announcement banners
shortTitle: Organization
intro: 'The Organization Announcement Banners API allows you to get, set, and remove the announcement banner for your organization.'
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖

View File

@@ -1,5 +1,7 @@
---
title: Billing
title: REST API endpoints for billing
shortTitle: Billing
allowTitleToDifferFromFilename: true
intro: Use the REST API to get billing information for an enterprise.
topics:
- API

View File

@@ -1,5 +1,7 @@
---
title: Billing
title: REST API endpoints for billing
shortTitle: Billing
allowTitleToDifferFromFilename: true
intro: Use the REST API to get billing information for an enterprise.
topics:
- API

View File

@@ -1,5 +1,6 @@
---
title: Protected branches
title: REST API endpoints for protected branches
shortTitle: Protected branches
intro: Use the REST API to manage protected branches.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'

View File

@@ -1,5 +1,7 @@
---
title: Branches
title: REST API endpoints for branches
shortTitle: Branches
allowTitleToDifferFromFilename: true
intro: Use the REST API to modify branches and their protection settings.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'

View File

@@ -1,5 +1,6 @@
---
title: Branches
title: REST API endpoints for branches and their settings
shortTitle: Branches
intro: Use the REST API to modify branches and their protection settings.
allowTitleToDifferFromFilename: true
versions:

View File

@@ -1,5 +1,7 @@
---
title: Checks
title: REST API endpoints for checks
shortTitle: Checks
allowTitleToDifferFromFilename: true
intro: 'Use the REST API to build {% data variables.product.prodname_github_apps %} that run powerful checks against the code changes in a repository.'
redirect_from:
- /v3/checks

View File

@@ -1,5 +1,6 @@
---
title: Check Runs
title: REST API endpoints for check runs
shortTitle: Check runs
intro: Use the REST API to manage check runs.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'

View File

@@ -1,5 +1,6 @@
---
title: Check Suites
title: REST API endpoints for check suites
shortTitle: Check suites
intro: Use the REST API to manage check suites.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'

View File

@@ -1,5 +1,5 @@
---
title: Classroom
title: REST API endpoints for {% data variables.product.prodname_classroom %}
shortTitle: Classroom
intro: 'Use the REST API to interact with {% data variables.product.prodname_classroom %}.'
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖

View File

@@ -1,5 +1,6 @@
---
title: Classroom
title: REST API endpoints for {% data variables.product.prodname_classroom %}
shortTitle: Classroom
intro: 'Use the REST API to interact with {% data variables.product.prodname_classroom %}.'
topics:
- API

View File

@@ -1,5 +1,7 @@
---
title: Codes of conduct
title: REST API endpoints for codes of conduct
shortTitle: Codes of conduct
allowTitleToDifferFromFilename: true
intro: Use the REST API to get information about codes of conduct.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'

View File

@@ -1,5 +1,7 @@
---
title: Codes of conduct
title: REST API endpoints for codes of conduct
shortTitle: Codes of conduct
allowTitleToDifferFromFilename: true
intro: Use the REST API to get information about codes of conduct.
versions:
fpt: '*'

View File

@@ -84,7 +84,7 @@ These endpoints are only accessible to authenticated {% data variables.product.p
The current version of your enterprise is returned in the REST API response header:
`X-GitHub-Enterprise-Version: {{currentVersion}}.0`
You can also read the current version by calling the [meta endpoint](/rest/meta).
You can also read the current version by calling `GET /meta`. For more information, see "[AUTOTITLE](/rest/meta)."
{% endif %}

View File

@@ -69,7 +69,7 @@ If a check run is in an incomplete state for more than 14 days, then the check r
As soon as you receive the [`check_suite`](/webhooks-and-events/webhooks/webhook-events-and-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.
Annotations add information from your check run to specific lines of code. Each annotation includes an `annotation_level` property, which can be `notice`, `warning`, or `failure`. The annotation also includes `path`, `start_line`, and `end_line` to specify what location the annotation refers to. The annotation includes a `message` to describe the result. For more information, see "[AUTOTITLE](/rest/checks/runs)" in the REST API reference documentation.
Annotations add information from your check run to specific lines of code. Each annotation includes an `annotation_level` property, which can be `notice`, `warning`, or `failure`. The annotation also includes `path`, `start_line`, and `end_line` to specify what location the annotation refers to. The annotation includes a `message` to describe the result. For more information, see "[AUTOTITLE](/rest/checks/runs)."
A check can also be manually re-run in the GitHub UI. See "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks#checks)" for more details. When this occurs, the GitHub App that created the check run will receive the [`check_run`](/webhooks-and-events/webhooks/webhook-events-and-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.

View File

@@ -1,5 +1,7 @@
---
title: Meta
title: REST API endpoints for meta data
shortTitle: Meta
allowTitleToDifferFromFilename: true
intro: >-
Use the REST API to get meta information about {% data
variables.product.product_name %}, including the IP addresses of {% data

View File

@@ -1,5 +1,7 @@
---
title: Meta
title: REST API endpoints for meta data
shortTitle: Meta
allowTitleToDifferFromFilename: true
intro: >-
Use the REST API to get meta information about {% data
variables.product.product_name %}, including the IP addresses of {% data

View File

@@ -1,5 +1,5 @@
---
title: Community metrics
title: REST API endpoints for community metrics
shortTitle: Community
allowTitleToDifferFromFilename: true
intro: Use the REST API to retrieve information about your community profile.

View File

@@ -1,5 +1,6 @@
---
title: Metrics
title: REST API endpoints for metrics
shortTitle: Metrics
intro: 'Use the REST API to retrieve the community profile, statistics, and traffic for your repository.'
allowTitleToDifferFromFilename: true
redirect_from:

View File

@@ -1,5 +1,5 @@
---
title: Repository statistics
title: REST API endpoints for repository statistics
shortTitle: Statistics
allowTitleToDifferFromFilename: true
intro: >-

View File

@@ -1,5 +1,5 @@
---
title: Repository traffic
title: REST API endpoints for repository traffic
shortTitle: Traffic
allowTitleToDifferFromFilename: true
intro: Use the REST API to retrieve information provided in your repository graph.

View File

@@ -1,5 +1,7 @@
---
title: Pages
title: REST API endpoints for {% data variables.product.prodname_pages %}
shortTitle: Pages
allowTitleToDifferFromFilename: true
intro: >-
Use the REST API to interact with {% data variables.product.prodname_pages %}
sites and builds.

View File

@@ -1,5 +1,7 @@
---
title: Pages
title: REST API endpoints for {% data variables.product.prodname_pages %}
shortTitle: Pages
allowTitleToDifferFromFilename: true
intro: >-
Use the REST API to interact with {% data variables.product.prodname_pages %}
sites and builds.

View File

@@ -9,44 +9,47 @@ topics:
- Policy
- Legal
---
GitHub events are community events intended for networking and collaboration in the tech community.
We value the participation of each member and want all attendees to have an enjoyable and fulfilling experience. Accordingly, all attendees are expected to show respect and courtesy to other attendees throughout all events hosted in the GitHub space.
To make clear what is expected, all attendees, speakers, exhibitors, organizers, and volunteers at any event in the GitHub space are required to conform to the following Code of Conduct. Organizers will enforce this code throughout the event.
## Code of Conduct
GitHub is dedicated to providing a positive and harassment-free event experience for everyone, regardless of age, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, ethnicity, race, religion, nationality, or level of experience. We do not tolerate harassment of event participants in any form, nor do we tolerate any behavior that would reasonably lead to another event participant being made to feel unsafe, insecure, or frightened for their physical or emotional well-being. All communication should be appropriate for a professional audience including people of many different backgrounds.
By attending a GitHub event, including any of the events or activities organized by GitHub in association with the GitHub event (collectively the "Event"), you represent that you have read, understand, and agree to the following GitHub Event Code of Conduct (hereinafter “Code of Conduct”). This Code of Conduct applies to all attendees, speakers, exhibitors, sponsors, organizers, staff, and volunteers (collectively “Event Participants”) at the Event.
GitHub values the participation of all Event Participants and aims to create an event where all Event Participants have an enjoyable and fulfilling experience. Accordingly, all Event Participants are expected to show respect and courtesy to other Event Participants throughout the Event.
GitHub is dedicated to providing a positive and harassment-free experience for everyone, regardless of age, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, ethnicity, race, religion, nationality, or level of experience.
We do not tolerate harassment of Event Participants in any form, nor do we tolerate any behavior that would reasonably lead to an Event Participant being made to feel unsafe, insecure, or frightened for their physical or emotional well-being. All communication and behavior should be appropriate for a professional setting including people of many different backgrounds.
Examples of encouraged behavior that contributes to a positive environment include:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for everyone at the event
- Showing empathy towards other participants
- Focusing on what is best for everyone at the Event
- Showing empathy towards others and Event Participants
Unacceptable behavior includes:
Unacceptable behavior includes, but is not limited to:
- The use of sexualized language or imagery, or inappropriate physical contact, sexual attention, or advances
- Trolling, insulting or derogatory comments, personal or political attacks, or sustained disruption of talks or other events
- Deliberate intimidation, stalking, following, or harassing photography or recording
- The use of sexualized language or imagery
- Inappropriate physical contact, sexual attention, or advances
- Trolling, insulting or derogatory comments or behavior
- Personal or political attacks toward Event Participants
- Sustained disruption of talks or any other events or activities organized by GitHub in association with the Event
- Intimidation, stalking, following, or harassing of Event Participants
- Photography or recording of Event Participants without their consent
- Harassment of any kind, even in a joking or ironic manner
- Other conduct which could reasonably be considered inappropriate in a professional setting
- Conduct which could reasonably be considered inappropriate in a professional setting
Be kind to others. Do not insult or put down other attendees. Behave professionally. Remember that harassment and sexist, racist, or exclusionary jokes are not appropriate at this event.
Each event guest is entirely responsible for their own actions.
Each Event Participant is entirely responsible for their own actions.
Thank you for helping to make this a welcoming, friendly space for all.
### Reporting an incident
## Reporting an incident
If you are being harassed, notice that someone else is being harassed, or have any other concerns, please contact the organizer by email (events@github.com) or phone/text (+1 415 842 2837), or by speaking to another GitHub employee or a security officer.
If you are being harassed, notice that someone else is being harassed, have any other concerns, or if you believe an Event Participant is not acting in a way compliant with this Code of Conduct, please speak directly with a venue security officer or GitHub employee for urgent help, or email us at [events@github.com](mailto:events@github.com) for non-urgent issues. For life threatening situations, please dial 911 immediately.
GitHubbers will be happy to help participants contact security or local law enforcement, escort to safety, or otherwise assist those experiencing harassment to feel safe for the duration of the conference. We value your attendance.
GitHub employees will be happy to help Event Participants contact security or local law enforcement, escort to safety, or otherwise assist those experiencing harassment to feel safe for the duration of the Event.
## Credit
Portions of this Code of Conduct are based on the [example anti-harassment policy](https://geekfeminism.wikia.org/wiki/Conference_anti-harassment/Policy) from the Geek Feminism wiki, created by the Ada Initiative and other volunteers, under a Creative Commons Zero license.
Portions of this Code of Conduct are based on the example anti-harassment policy from the Geek Feminism wiki, created by the Ada Initiative and other volunteers, under a Creative Commons Zero license.

View File

@@ -10,54 +10,67 @@ topics:
- Legal
---
By RSVP'ing to or attending a GitHub event, including any of the events or activities organized by GitHub in association with the GitHub event (collectively the "Event"), you signal that you have read, understand, and agree to the following Event Terms and Conditions.
By RSVP'ing to or attending a GitHub event, including any of the events or activities organized by GitHub in association with the GitHub event (collectively the "Event"), you represent that you have read, understand, and agree to the following GitHub Event Terms (hereinafter “Event Terms”).
## 1. Basic requirements to attend - including the Event Code of Conduct
In order to participate in the Event, you represent that
- you have the requisite power and authority to enter into these Event Terms
- You have the requisite capacity and authority to enter into these Event Terms;
- You have read and understood these Event Terms and the [AUTOTITLE](/site-policy/github-terms/github-terms-of-service);
- You agree to abide by the [Event Code of Conduct](/site-policy/github-terms/github-event-code-of-conduct); and
- If alcohol is being served at the Event, you are at least 21 years old or over the legal drinking age at the location where the Event is being held.
- you have read and understood these Event Terms as well as the [GitHub.com Terms of Service](/site-policy/github-terms/github-terms-of-service)
If asked to stop behavior deemed harassing or prohibited, you must comply immediately. If you violate the [Event Code of Conduct](/site-policy/github-terms/github-event-code-of-conduct) or these Event Terms, the Event organizers may take any action they deem appropriate in their discretion, including warnings or expulsion from the Event with no refund. You must at all times obey the instructions or directions of the Event organizers.
- you agree to abide by the [Event Code of Conduct](/site-policy/github-terms/github-event-code-of-conduct), which seeks to provide a harassment-free experience for everyone
## 2. Pictures and videos
- if alcohol is being served at a GitHub event, you represent that you are at least 21 years old, or otherwise over the legal drinking age in your jurisdiction.
GitHub and its partners, agents, or contractors sometimes take photos and videos at the Event. By participating or attending the Event, you agree that you may appear in some of these photos and videos, and you authorize GitHub's use of them during and after the Event.
Participants asked to stop any harassing or other prohibited behavior are expected to comply immediately. If a participant engages in behavior that violates the [Event Code of Conduct](/site-policy/github-terms/github-event-code-of-conduct) or these Terms, the event organizers may take any action they deem appropriate, including warning the offender or expulsion from the event or conference with no refund.
Additionally, if you take any photos or videos at the Event and provide them to GitHub, you authorize us to use them in the same fashion, and represent that the individuals that appear in your photos and videos have consented to such use.
## 2. Pictures
## 3. Information sharing
GitHub or its partners sometimes take photos and videos at GitHub events. By participating or attending the Event, you agree that you may appear in some of these photos and videos, and you authorize GitHub's use of them. On the flip side, if you take any photos or videos of attendees at the Event and provide them to us, you authorize us to use them in the same fashion, and represent that the attendees that appear in your photos and videos have also consented to such use.
Event sponsors, exhibitors, and other third parties may directly request your personal or other information at their exhibit booths, auxiliary events, or presentations. Providing any information to them is voluntary and optional, and you should review their privacy policies to determine how they will treat your personal information and whether you are comfortable with that treatment.
## 3. Risk, liability, and indemnity
If during the event you provide your information to a sponsor, exhibitor, or third party, including but not limited to (1) RSVPing or attending a session or program hosted by a third party other than GitHub, (2) presenting your badge for scanning at an exhibitor booth or breakout session, (3) requesting that a sponsor contact you via their virtual page on githubuniverse.com, or (4) entering a raffle, sweepstakes, or promotional event put on by third party other than GitHub, you understand and agree that your information will go to a non-GitHub entity and GitHub takes no responsibility for how that company uses or processes your personal information. You should review their privacy policies to determine how they will treat your personal information and whether you are comfortable with that treatment.
Event sponsors and exhibitors are required to comply with GitHubs privacy requirements and all applicable law including protecting Personal Data from unauthorized use, access or disclosure.
## 4. Risk, liability, and indemnity
### Assumption of risk
Although we try to create a safe environment at the Event, accidents or other bad things happen, even to good people. We ask that you do your part to help limit the possibility that you might get injured at the Event.
Although we try to create a safe environment at the Event, we cannot guarantee 100% safety for participants. Please do your part to help reduce your chance of being injured at the Event.
You agree to carefully consider the risks inherent in any activities that you choose to take part in and to take reasonable precautions before you choose to attend or participate at a GitHub event. For example, you should ensure that you are in good physical health before engaging in any physical activity at a GitHub event, and you should always drink responsibly given the risks associated with drunk driving and participating in activities while your judgment is impaired. It's always good to remember that other event guests may be less responsible than you, and may themselves create additional risk to you despite their best intentions.
In short, you understand that your attendance and participation at any GitHub event is voluntary, and you agree to assume responsibility for any resulting injuries to the fullest extent permitted under applicable law.
By the same token, you agree that GitHub is not responsible for any injuries or accidents that you might sustain at any events that GitHub doesn't organize or control.
You agree to carefully consider the risks inherent in any activities you choose to take part in at the Event and to take reasonable precautions before you choose to attend or participate at the Event. You are responsible for your own actions and any resulting consequences. You agree to assume responsibility for your actions and your attendance to the fullest extent permitted by law. GitHub is not responsible for any injuries or accidents that you might sustain at the Event.
### Release of liability
You (for yourself, your heirs, personal representatives, or assigns, and anyone else who might make a claim on your behalf) hereby release, waive, discharge and covenant not to sue GitHub and its respective parent companies, subsidiaries, affiliates, officers, directors, partners, shareholders, members, agents, employees, vendors, sponsors, and volunteers from any and all claims, demands, causes of action, damages, losses or expenses (including court costs and reasonable attorneys' fees) which may arise out of, result from, or relate in any way to your attendance at the Event or any related event, except, of course, for any gross negligence or willful misconduct on our part.
You (for yourself, your heirs, personal representatives, or assigns, and anyone else who could make a claim on your behalf) hereby release, waive, discharge and covenant not to sue GitHub and its parent companies, subsidiaries, affiliates, officers, directors, partners, shareholders, members, agents, employees, vendors, sponsors, and volunteers from any and all claims, demands, causes of action, damages, losses, or expenses (including court costs and reasonable attorneys' fees) which may arise out of, result from, or relate in any way to your attendance at the Event. This release will not apply if GitHub is grossly negligent or engages in willful misconduct.
### Indemnity
By the same token, you agree to indemnify and hold GitHub, its parents, subsidiaries, affiliates, officers, directors, employees, agents and representatives harmless, including costs, liabilities and legal fees, from any claim or demand made by any third party due to, related to, or connected with your attendance or conduct at the Event or any related event.
You agree to indemnify and hold GitHub, its parents, subsidiaries, affiliates, officers, directors, employees, agents, and representatives harmless, including costs, liabilities, and legal fees, from any claim or demand made by any third party due to, related to, or connected with your attendance or conduct at the Event.
## 4. Termination
## 5. Termination
While we hope not to, GitHub may prohibit your attendance at any GitHub event at any time if you fail to abide by these Event Terms and the [Event Code of Conduct](/site-policy/github-terms/github-event-code-of-conduct), the [GitHub.com Terms of Service](/site-policy/github-terms/github-terms-of-service), or for any or no reason, without notice or liability of any kind. Section 3 (Risk, liability, and indemnity) will continue to apply following any termination.
GitHub reserves the right to revoke your permission to attend the Event or to otherwise prohibit or limit your attendance at the Event for any or no reason, without notice or liability of any kind. The entirety of Section 4 of these Event Terms will continue to apply if your participation at the Event is terminated.
## 5. Choice of law and venue
## 6. Choice of law and venue
California law will govern these Event Terms, as well as any claim, cause of action or dispute that might arise between you and GitHub (a "Claim"), without regard to conflict of law provisions. FOR ANY CLAIM BROUGHT BY EITHER PARTY, YOU AGREE TO SUBMIT AND CONSENT TO THE PERSONAL AND EXCLUSIVE JURISDICTION IN, AND THE EXCLUSIVE VENUE OF, THE STATE AND FEDERAL COURTS LOCATED WITHIN SAN FRANCISCO COUNTY, CALIFORNIA.
## 6. Miscellaneous terms
## 7. Miscellaneous terms
You agree that you will not represent yourself as an employee, representative, or agent of GitHub (unless, of course, you are actually employed by GitHub). We reserve the right to cancel the Event or any related event at any time, for any reason, and without liability or prejudice. Any failure on GitHub's part to exercise or enforce any right or provision of these terms does not constitute a waiver of such right or provision. If any provision of these terms is found to be unenforceable or invalid, that provision shall be limited or eliminated to the minimum extent necessary so that the Event Terms shall otherwise remain in full force and effect and enforceable.
You agree that you will not represent yourself as an employee, representative, or agent of GitHub (unless, of course, you are actually employed by GitHub).
We reserve the right to cancel the Event or any related event at any time, for any reason, and without liability or prejudice.
Any failure by GitHub to exercise or enforce any right or provision of these terms does not constitute a waiver of such right or provision. If any provision of these terms is found to be unenforceable or invalid, that provision shall be limited or eliminated to the minimum extent necessary so that the Event Terms shall otherwise remain in full force and effect and enforceable.
The views expressed by any event attendee, speaker, exhibitor, or sponsor are not necessarily those of GitHub. All attendees, speakers, exhibitors, and sponsors are solely responsible for the content of all presentations and any other material used at the Event.
GitHub reserves the right to update these Event Terms in its sole discretion and without prior notice. These Event Terms apply to all event participants (attendees, speakers, sponsors, exhibitors, staff, and crew). You are advised to review these Event Terms periodically.
These Event Terms were last updated on February 7th 2024.

View File

@@ -1,11 +1,11 @@
When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be `pending`. Any previously pending job or workflow in the concurrency group will be canceled. To also cancel any currently running job or workflow in the same concurrency group, specify `cancel-in-progress: true`.
When a concurrent job or workflow is queued, if another job or workflow run using the same concurrency group in the repository is in progress, the queued job or workflow run will be `pending`. Any pending job or workflow run in the same concurrency group will be canceled when a new job or workflow run is queued. To also cancel any currently running job or workflow run in the same concurrency group, specify `cancel-in-progress: true`.
{% note %}
**Notes:**
- The concurrency group name is case insensitive. For example, `prod` and `Prod` will be treated as the same concurrency group.
- Ordering is not guaranteed for jobs or runs using concurrency groups, they are handled in the order that they are processed.
- Ordering is not guaranteed for jobs or workflow runs using concurrency groups. Jobs or workflow runs in the same concurrency group are handled in an arbitrary order.
{% endnote %}

View File

@@ -13,4 +13,4 @@ You can get an up-to-date list of IP ranges used by {% data variables.product.pr
The `github_enterprise_importer` key in the response contains a list of IP ranges used for migrations.
For more information, see "[AUTOTITLE](/rest/meta#get-github-meta-information)" in the REST API documentation.
For more information, see "[AUTOTITLE](/rest/meta#get-github-meta-information)."

View File

@@ -1 +1 @@
When someone stars a repository. {% data reusables.webhooks.action_type_desc %} For more information, see the "[AUTOTITLE](/rest/activity#starring)" REST API.
When someone stars a repository. {% data reusables.webhooks.action_type_desc %} For more information, see "[AUTOTITLE](/rest/activity#starring)."