Skip to content

Commit

Permalink
repo sync
Browse files Browse the repository at this point in the history
  • Loading branch information
Octomerger authored Oct 13, 2020
2 parents b5081ec + 63da5c7 commit ea68c4f
Show file tree
Hide file tree
Showing 25 changed files with 140 additions and 405 deletions.
10 changes: 5 additions & 5 deletions content/actions/reference/events-that-trigger-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ on:

#### `deployment`

Runs your workflow anytime someone creates a deployment, which triggers the `deployment` event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see "[Deployments](/v3/repos/deployments/)."
Runs your workflow anytime someone creates a deployment, which triggers the `deployment` event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see "[Deployments](/rest/reference/repos#deployments)."

| Webhook event payload | Activity types | `GITHUB_SHA` | `GITHUB_REF` |
| --------------------- | -------------- | ------------ | -------------|
Expand All @@ -247,7 +247,7 @@ on:

#### `deployment_status`

Runs your workflow anytime a third party provides a deployment status, which triggers the `deployment_status` event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see "[Create a deployment status](/v3/repos/deployments/#create-a-deployment-status)."
Runs your workflow anytime a third party provides a deployment status, which triggers the `deployment_status` event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see "[Create a deployment status](/rest/reference/repos#create-a-deployment-status)."

| Webhook event payload | Activity types | `GITHUB_SHA` | `GITHUB_REF` |
| --------------------- | -------------- | ------------ | -------------|
Expand Down Expand Up @@ -296,13 +296,13 @@ on:

#### `issue_comment`

Runs your workflow anytime the `issue_comment` event occurs. {% data reusables.developer-site.multiple_activity_types %} For information about the REST API, see "[Issue comments](/v3/issues/comments/)."
Runs your workflow anytime the `issue_comment` event occurs. {% data reusables.developer-site.multiple_activity_types %} For information about the REST API, see "[Issue comments](/developers/webhooks-and-events/webhook-events-and-payloads#issue_comment)."

{% data reusables.github-actions.branch-requirement %}

| Webhook event payload | Activity types | `GITHUB_SHA` | `GITHUB_REF` |
| --------------------- | -------------- | ------------ | -------------|
| [`issue_comment`](/v3/activity/event_types/#issue_comment) | - `created`<br/>- `edited`<br/>- `deleted`<br/> | Last commit on default branch | Default branch |
| [`issue_comment`](/rest/reference/activity#issue_comment) | - `created`<br/>- `edited`<br/>- `deleted`<br/> | Last commit on default branch | Default branch |

{% data reusables.developer-site.limit_workflow_to_activity_types %}

Expand Down Expand Up @@ -376,7 +376,7 @@ on:

#### `page_build`

Runs your workflow anytime someone pushes to a {% data variables.product.product_name %} Pages-enabled branch, which triggers the `page_build` event. For information about the REST API, see "[Pages](/v3/repos/pages/)."
Runs your workflow anytime someone pushes to a {% data variables.product.product_name %} Pages-enabled branch, which triggers the `page_build` event. For information about the REST API, see "[Pages](/rest/reference/repos#pages)."

{% data reusables.github-actions.branch-requirement %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Permission | Description
[`checks`](/rest/reference/permissions-required-for-github-apps/#permission-on-checks) | Grants access to the [Checks API](/v3/checks/). Can be one of: `none`, `read`, or `write`.
`content_references` | Grants access to the "[Create a content attachment](/v3/apps/installations/#create-a-content-attachment)" endpoint. Can be one of: `none`, `read`, or `write`.
[`contents`](/rest/reference/permissions-required-for-github-apps/#permission-on-contents) | Grants access to various endpoints that allow you to modify repository contents. Can be one of: `none`, `read`, or `write`.
[`deployments`](/rest/reference/permissions-required-for-github-apps/#permission-on-deployments) | Grants access to the [Deployments API](/v3/repos/deployments/). Can be one of: `none`, `read`, or `write`.
[`deployments`](/rest/reference/permissions-required-for-github-apps/#permission-on-deployments) | Grants access to the [Deployments API](/rest/reference/repos#deployments). Can be one of: `none`, `read`, or `write`.
[`emails`](/rest/reference/permissions-required-for-github-apps/#permission-on-emails) | Grants access to the [Emails API](/v3/users/emails/). Can be one of: `none`, `read`, or `write`.
[`followers`](/rest/reference/permissions-required-for-github-apps/#permission-on-followers) | Grants access to the [Followers API](/v3/users/followers/). Can be one of: `none`, `read`, or `write`.
[`gpg_keys`](/rest/reference/permissions-required-for-github-apps/#permission-on-gpg-keys) | Grants access to the [GPG Keys API](/v3/users/gpg_keys/). Can be one of: `none`, `read`, or `write`.
Expand All @@ -63,11 +63,11 @@ Permission | Description
[`members`](/rest/reference/permissions-required-for-github-apps/#permission-on-members) | Grants access to manage an organization's members. Can be one of: `none`, `read`, or `write`.{% if currentVersion == "free-pro-team@latest" %}
[`metadata`](/rest/reference/permissions-required-for-github-apps/#metadata-permissions) | Grants access to read-only endpoints that do not leak sensitive data. Can be `read` or `none`. Defaults to `read` when you set any permission, or defaults to `none` when you don't specify any permissions for the {% data variables.product.prodname_github_app %}.
[`organization_administration`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-administration) | Grants access to "[Update an organization](/v3/orgs/#update-an-organization)" endpoint and the [Organization Interaction Restrictions API](/v3/interactions/orgs/#set-interaction-restrictions-for-an-organization). Can be one of: `none`, `read`, or `write`.{% endif %}
[`organization_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-hooks) | Grants access to the [Organization Webhooks API](/v3/orgs/hooks/). Can be one of: `none`, `read`, or `write`.
[`organization_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-hooks) | Grants access to the [Organization Webhooks API](/rest/reference/orgs#webhooks/). Can be one of: `none`, `read`, or `write`.
`organization_plan` | Grants access to get information about an organization's plan using the "[Get an organization](/v3/orgs/#get-an-organization)" endpoint. Can be one of: `none` or `read`.
[`organization_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-projects) | Grants access to the [Projects API](/v3/projects/). Can be one of: `none`, `read`, `write`, or `admin`.{% if currentVersion == "free-pro-team@latest" %}
[`organization_user_blocking`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-projects) | Grants access to the [Blocking Organization Users API](/v3/orgs/blocking/). Can be one of: `none`, `read`, or `write`.{% endif %}
[`pages`](/rest/reference/permissions-required-for-github-apps/#permission-on-pages) | Grants access to the [Pages API](/v3/repos/pages/). Can be one of: `none`, `read`, or `write`.
[`pages`](/rest/reference/permissions-required-for-github-apps/#permission-on-pages) | Grants access to the [Pages API](/rest/reference/repos#pages). Can be one of: `none`, `read`, or `write`.
`plan` | Grants access to get information about a user's GitHub plan using the "[Get a user](/v3/users/#get-a-user)" endpoint. Can be one of: `none` or `read`.
[`pull_requests`](/rest/reference/permissions-required-for-github-apps/#permission-on-pull-requests) | Grants access to various pull request endpoints. Can be one of: `none`, `read`, or `write`.
[`repository_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-hooks) | Grants access to the [Repository Webhooks API](/v3/repos/hooks/). Can be one of: `none`, `read`, or `write`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -241,25 +241,25 @@ While most of your API interaction should occur using your server-to-server inst

##### Deployment Statuses

* [List deployment statuses](/v3/repos/deployments/#list-deployment-statuses)
* [Create a deployment status](/v3/repos/deployments/#create-a-deployment-status)
* [Get a deployment status](/v3/repos/deployments/#get-a-deployment-status)
* [List deployment statuses](/rest/reference/repos#list-deployment-statuses)
* [Create a deployment status](/rest/reference/repos#create-a-deployment-status)
* [Get a deployment status](/rest/reference/repos#get-a-deployment-status)

##### Deployments

* [List deployments](/v3/repos/deployments/#list-deployments)
* [Create a deployment](/v3/repos/deployments/#create-a-deployment)
* [Get a deployment](/v3/repos/deployments/#get-a-deployment){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
* [Delete a deployment](/v3/repos/deployments/#delete-a-deployment){% endif %}
* [List deployments](/rest/reference/repos#list-deployments)
* [Create a deployment](/rest/reference/repos#create-a-deployment)
* [Get a deployment](/rest/reference/repos#get-a-deployment){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
* [Delete a deployment](/rest/reference/repos#delete-a-deployment){% endif %}

##### Events

* [List public events for a network of repositories](/v3/activity/events/#list-public-events-for-a-network-of-repositories)
* [List public organization events](/v3/activity/events/#list-public-organization-events)
* [List public events for a network of repositories](/rest/reference/activity#list-public-events-for-a-network-of-repositories)
* [List public organization events](/rest/reference/activity#list-public-organization-events)

##### Feeds

* [Get feeds](/v3/activity/feeds/#get-feeds)
* [Get feeds](/rest/reference/activity#get-feeds)

##### Git Blobs

Expand Down Expand Up @@ -388,12 +388,12 @@ While most of your API interaction should occur using your server-to-server inst

##### Organization Hooks

* [List organization webhooks](/v3/orgs/hooks/#list-organization-webhooks)
* [Create an organization webhook](/v3/orgs/hooks/#create-an-organization-webhook)
* [Get an organization webhook](/v3/orgs/hooks/#get-an-organization-webhook)
* [Update an organization webhook](/v3/orgs/hooks/#update-an-organization-webhook)
* [Delete an organization webhook](/v3/orgs/hooks/#delete-an-organization-webhook)
* [Ping an organization webhook](/v3/orgs/hooks/#ping-an-organization-webhook)
* [List organization webhooks](/rest/reference/orgs#webhooks/#list-organization-webhooks)
* [Create an organization webhook](/rest/reference/orgs#webhooks/#create-an-organization-webhook)
* [Get an organization webhook](/rest/reference/orgs#webhooks/#get-an-organization-webhook)
* [Update an organization webhook](/rest/reference/orgs#webhooks/#update-an-organization-webhook)
* [Delete an organization webhook](/rest/reference/orgs#webhooks/#delete-an-organization-webhook)
* [Ping an organization webhook](/rest/reference/orgs#webhooks/#ping-an-organization-webhook)

{% if currentVersion == "free-pro-team@latest" %}
##### Organization Invitations
Expand Down Expand Up @@ -616,7 +616,7 @@ While most of your API interaction should occur using your server-to-server inst
* [Delete a repository](/v3/repos/#delete-a-repository)
* [Compare two commits](/v3/repos/commits/#compare-two-commits)
* [List repository contributors](/v3/repos/#list-repository-contributors)
* [List forks](/v3/repos/forks/#list-forks)
* [List forks](/rest/reference/repos#list-forks)
* [Create a fork](/v3/repos/forks/#create-a-fork)
* [List repository languages](/v3/repos/#list-repository-languages)
* [List repository tags](/v3/repos/#list-repository-tags)
Expand All @@ -629,13 +629,13 @@ While most of your API interaction should occur using your server-to-server inst

##### Repository Activity

* [List stargazers](/v3/activity/starring/#list-stargazers)
* [List watchers](/v3/activity/watching/#list-watchers)
* [List repositories starred by a user](/v3/activity/starring/#list-repositories-starred-by-a-user)
* [Check if a repository is starred by the authenticated user](/v3/activity/starring/#check-if-a-repository-is-starred-by-the-authenticated-user)
* [Star a repository for the authenticated user](/v3/activity/starring/#star-a-repository-for-the-authenticated-user)
* [Unstar a repository for the authenticated user](/v3/activity/starring/#unstar-a-repository-for-the-authenticated-user)
* [List repositories watched by a user](/v3/activity/watching/#list-repositories-watched-by-a-user)
* [List stargazers](/rest/reference/activity#list-stargazers)
* [List watchers](/rest/reference/activity#list-watchers)
* [List repositories starred by a user](/rest/reference/activity#list-repositories-starred-by-a-user)
* [Check if a repository is starred by the authenticated user](/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user)
* [Star a repository for the authenticated user](/rest/reference/activity#star-a-repository-for-the-authenticated-user)
* [Unstar a repository for the authenticated user](/rest/reference/activity#unstar-a-repository-for-the-authenticated-user)
* [List repositories watched by a user](/rest/reference/activity#list-repositories-watched-by-a-user)

{% if currentVersion == "free-pro-team@latest" %}
##### Repository Automated Security Fixes
Expand Down Expand Up @@ -753,14 +753,14 @@ While most of your API interaction should occur using your server-to-server inst

##### Repository Pages

* [Get a GitHub Pages site](/v3/repos/pages/#get-a-github-pages-site)
* [Create a GitHub Pages site](/v3/repos/pages/#create-a-github-pages-site)
* [Update information about a GitHub Pages site](/v3/repos/pages/#update-information-about-a-github-pages-site)
* [Delete a GitHub Pages site](/v3/repos/pages/#delete-a-github-pages-site)
* [List GitHub Pages builds](/v3/repos/pages/#list-github-pages-builds)
* [Request a GitHub Pages build](/v3/repos/pages/#request-a-github-pages-build)
* [Get GitHub Pages build](/v3/repos/pages/#get-github-pages-build)
* [Get latest pages build](/v3/repos/pages/#get-latest-pages-build)
* [Get a GitHub Pages site](/rest/reference/repos#get-a-github-pages-site)
* [Create a GitHub Pages site](/rest/reference/repos#create-a-github-pages-site)
* [Update information about a GitHub Pages site](/rest/reference/repos#update-information-about-a-github-pages-site)
* [Delete a GitHub Pages site](/rest/reference/repos#delete-a-github-pages-site)
* [List GitHub Pages builds](/rest/reference/repos#list-github-pages-builds)
* [Request a GitHub Pages build](/rest/reference/repos#request-a-github-pages-build)
* [Get GitHub Pages build](/rest/reference/repos#get-github-pages-build)
* [Get latest pages build](/rest/reference/repos#get-latest-pages-build)

{% if currentVersion != "free-pro-team@latest" %}
##### Repository Pre Receive Hooks
Expand All @@ -773,17 +773,17 @@ While most of your API interaction should occur using your server-to-server inst

##### Repository Releases

* [List releases](/v3/repos/releases/#list-releases)
* [Create a release](/v3/repos/releases/#create-a-release)
* [Get a release](/v3/repos/releases/#get-a-release)
* [Update a release](/v3/repos/releases/#update-a-release)
* [Delete a release](/v3/repos/releases/#delete-a-release)
* [List release assets](/v3/repos/releases/#list-release-assets)
* [Get a release asset](/v3/repos/releases/#get-a-release-asset)
* [Update a release asset](/v3/repos/releases/#update-a-release-asset)
* [Delete a release asset](/v3/repos/releases/#delete-a-release-asset)
* [Get the latest release](/v3/repos/releases/#get-the-latest-release)
* [Get a release by tag name](/v3/repos/releases/#get-a-release-by-tag-name)
* [List releases](/rest/reference/repos/#list-releases)
* [Create a release](/rest/reference/repos/#create-a-release)
* [Get a release](/rest/reference/repos/#get-a-release)
* [Update a release](/rest/reference/repos/#update-a-release)
* [Delete a release](/rest/reference/repos/#delete-a-release)
* [List release assets](/rest/reference/repos/#list-release-assets)
* [Get a release asset](/rest/reference/repos/#get-a-release-asset)
* [Update a release asset](/rest/reference/repos/#update-a-release-asset)
* [Delete a release asset](/rest/reference/repos/#delete-a-release-asset)
* [Get the latest release](/rest/reference/repos/#get-the-latest-release)
* [Get a release by tag name](/rest/reference/repos/#get-a-release-by-tag-name)

##### Repository Stats

Expand Down
4 changes: 2 additions & 2 deletions content/developers/webhooks-and-events/about-webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ versions:

Webhooks allow you to build or set up integrations, such as [{% data variables.product.prodname_github_app %}s](/apps/building-github-apps/) or [{% data variables.product.prodname_oauth_app %}s](/apps/building-oauth-apps/), which subscribe to certain events on GitHub.com. When one of those events is triggered, we'll send a HTTP POST payload to the webhook's configured URL. Webhooks can be used to update an external issue tracker, trigger CI builds, update a backup mirror, or even deploy to your production server. You're only limited by your imagination.

Webhooks can be installed on{% if currentVersion != "free-pro-team@latest" %} a [{% data variables.product.prodname_ghe_server %} instance](/v3/enterprise-admin/global_webhooks/),{% endif %} an [organization][org-hooks], a specific [repository][repo-hooks], or a {% data variables.product.prodname_github_app %}. Once installed, the webhook will be sent each time one or more subscribed events occurs.
Webhooks can be installed on{% if currentVersion != "free-pro-team@latest" %} a [{% data variables.product.prodname_ghe_server %} instance](/rest/reference/enterprise-admin#global-webhooks/),{% endif %} an [organization][org-hooks], a specific [repository][repo-hooks], or a {% data variables.product.prodname_github_app %}. Once installed, the webhook will be sent each time one or more subscribed events occurs.

You can create up to {% if currentVersion != "free-pro-team@latest" %}250{% else %}20{% endif %} webhooks for each event on each installation target {% if currentVersion != "free-pro-team@latest" %}({% data variables.product.prodname_ghe_server %} instance, specific organization, or specific repository).{% else %}(specific organization or specific repository).{% endif %}

Expand All @@ -29,5 +29,5 @@ See "[Webhook event payloads](/webhooks/event-payloads)" for the list of availab

For more information about the `ping` event webhook payload, see the [`ping`](/webhooks/event-payloads/#ping) event.

[org-hooks]: /v3/orgs/hooks/
[org-hooks]: /rest/reference/orgs#webhooks/
[repo-hooks]: /v3/repos/hooks/
Loading

0 comments on commit ea68c4f

Please sign in to comment.