Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions content/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ See the [contributing docs](https://docs.github.com/en/contributing) for general
- [`defaultTool`](#defaulttool)
- [`learningTracks`](#learningtracks)
- [`includeGuides`](#includeguides)
- [`journeyTracks`](#journeytracks)
- [`type`](#type)
- [`topics`](#topics)
- [`communityRedirect`](#communityRedirect)
Expand Down Expand Up @@ -252,6 +253,35 @@ includeGuides:
- /actions/guides/building-and-testing-powershell
```

### `journeyTracks`
- Purpose: Define journeys for journey landing pages.
- Type: `Array` of objects with the following properties:
- `id` (required): Unique identifier for the journey. The id only needs to be unique for journeys within a single journey landing page.
- `title` (required): Display title for the journey (supports Liquid variables)
- `description` (optional): Description of the journey (supports Liquid variables)
- `guides` (required): Array of article paths that make up this journey
- Only applicable when used with `layout: journey-landing`.
- Optional.

Example:

```yaml
journeyTracks:
- id: 'getting_started'
title: 'Getting started with {% data variables.product.prodname_actions %}'
description: 'Learn the basics of GitHub Actions.'
guides:
- '/actions/quickstart'
- '/actions/learn-github-actions'
- '/actions/using-workflows'
- id: 'advanced'
title: 'Advanced {% data variables.product.prodname_actions %}'
description: 'Dive deeper into advanced features.'
guides:
- '/actions/using-workflows/workflow-syntax-for-github-actions'
- '/actions/deployment/deploying-with-github-actions'
```

### `type`
- Purpose: Indicate the type of article.
- Type: `String`, one of the `overview`, `quick_start`, `tutorial`, `how_to`, `reference`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---

Check warning on line 1 in content/contributing/writing-for-github-docs/using-yaml-frontmatter.md

View workflow job for this annotation

GitHub Actions / lint-content

Frontmatter properties must meet character limits and required property requirements

Missing required property 'topics' for article content type.
title: Using YAML frontmatter
shortTitle: YAML frontmatter
intro: 'You can use YAML frontmatter to define versioning, add metadata, and control the layout for articles.'
Expand Down Expand Up @@ -39,6 +39,7 @@
* [`defaultTool`](#defaulttool)
* [`learningTracks`](#learningtracks)
* [`includeGuides`](#includeguides)
* [`journeyTracks`](#journeytracks)
* [`type`](#type)
* [`topics`](#topics)
* [`communityRedirect`](#communityredirect)
Expand Down Expand Up @@ -249,6 +250,36 @@
- /actions/guides/building-and-testing-powershell
```

### `journeyTracks`

* Purpose: Define journeys for journey landing pages.
* Type: `Array` of objects with the following properties:
* `id` (required): Unique identifier for the journey. The id only needs to be unique for journeys within a single journey landing page.
* `title` (required): Display title for the journey (supports Liquid variables)
* `description` (optional): Description of the journey (supports Liquid variables)
* `guides` (required): Array of article paths that make up this journey
* Only applicable when used with `layout: journey-landing`.
* Optional.

Example:

```yaml
journeyTracks:
- id: 'getting_started'
title: 'Getting started with {% data variables.product.prodname_actions %}'
description: 'Learn the basics of GitHub Actions.'
guides:
- '/actions/quickstart'
- '/actions/learn-github-actions'
- '/actions/using-workflows'
- id: 'advanced'
title: 'Advanced {% data variables.product.prodname_actions %}'
description: 'Dive deeper into advanced features.'
guides:
- '/actions/using-workflows/workflow-syntax-for-github-actions'
- '/actions/deployment/deploying-with-github-actions'
```

### `type`

* Purpose: Indicate the type of article.
Expand Down Expand Up @@ -301,7 +332,7 @@
Index pages are the table of contents files for the Docs site. Every product, category, and map topic subdirectory has an `index.md` file that provides an overview of the content and links to every child article. Each `index.md` must contain a `children` frontmatter property with a list of relative links to the child pages of the product, category, or map topic. Index pages require a `versions` frontmatter property, and the actual value will be computed at runtime based on the versions of children articles.

> [!NOTE]
> The site only knows about paths included in `children` frontmatter. If a directory or article exists but is **not** included in `children`, its path will return a 404.

Check warning on line 335 in content/contributing/writing-for-github-docs/using-yaml-frontmatter.md

View workflow job for this annotation

GitHub Actions / lint-content

Do not use more than one emphasis/strong

Do not use multiple emphasis types in a single string: code + bold.

## Homepage

Expand Down
81 changes: 28 additions & 53 deletions content/rest/using-the-rest-api/github-event-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,31 +63,33 @@ Link: <https://api.github.com/resource?page=2>; rel="next",
```json
[
{
"id": "12345",
"type": "WatchEvent",
"public": false,
"payload": {
"actor": {
"id": 1,
"login": "octocat",
"display_login": "octocat",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"avatar_url": "https://github.com/images/error/octocat_happy.gif"
},
"repo": {
"id": 3,
"name": "octocat/Hello-World",
"url": "https://api.github.com/repos/octocat/Hello-World"
},
"actor": {
"id": 1,
"login": "octocat",
"gravatar_id": "",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"url": "https://api.github.com/users/octocat"
"payload": {
"action": "started"
},
"public": false,
"created_at": "2011-09-06T17:26:27Z",
"org": {
"id": 1,
"login": "github",
"gravatar_id": "",
"url": "https://api.github.com/orgs/github",
"avatar_url": "https://github.com/images/error/octocat_happy.gif"
},
"created_at": "2011-09-06T17:26:27Z",
"id": "12345"
}
]
```
Expand Down Expand Up @@ -122,6 +124,20 @@ Link: <https://api.github.com/resource?page=2>; rel="next",

{% data reusables.webhooks.delete_properties %}

{% ifversion fpt or ghec %}

## DiscussionEvent

{% data reusables.webhooks.discussion_short_desc %}

{% data reusables.webhooks.events_api_payload %}

### Event `payload` object for DiscussionEvent

{% data reusables.webhooks.discussion_properties %}

{% endif %}

## ForkEvent

{% data reusables.webhooks.fork_short_desc %}
Expand Down Expand Up @@ -202,11 +218,7 @@ This event returns an empty `payload` object.

### Event `payload` object for PullRequestReviewEvent

Key | Type | Description
----|------|-------------
`action` | `string` | The action that was performed. Can be `created`.
`pull_request` | `object` | The pull request the review pertains to.
`review` | `object` | The review that was affected.
{% data reusables.webhooks.pull_request_review_properties %}

## PullRequestReviewCommentEvent

Expand All @@ -219,16 +231,6 @@ Key | Type | Description
{% data reusables.webhooks.pull_request_review_comment_event_api_properties %}
{% data reusables.webhooks.pull_request_review_comment_properties %}

## PullRequestReviewThreadEvent

{% data reusables.webhooks.pull_request_review_thread_short_desc %}

{% data reusables.webhooks.events_api_payload %}

### Event `payload` object for PullRequestReviewThreadEvent

{% data reusables.webhooks.pull_request_thread_properties %}

## PushEvent

{% data reusables.webhooks.push_short_desc %}
Expand All @@ -237,22 +239,7 @@ Key | Type | Description

### Event `payload` object for PushEvent

Key | Type | Description
----|------|-------------
`push_id` | `integer` | Unique identifier for the push.
`size`|`integer` | The number of commits in the push.
`distinct_size`|`integer` | The number of distinct commits in the push.
`ref`|`string` | The full [`git ref`](/rest/git/refs) that was pushed. Example: `refs/heads/main`.
`head`|`string` | The SHA of the most recent commit on `ref` after the push.
`before`|`string` | The SHA of the most recent commit on `ref` before the push.
`commits`|`array` | An array of commit objects describing the pushed commits. (The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](/rest/repos#commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.)
`commits[][sha]`|`string` | The SHA of the commit.
`commits[][message]`|`string` | The commit message.
`commits[][author]`|`object` | The git author of the commit.
`commits[][author][name]`|`string` | The git author's name.
`commits[][author][email]`|`string` | The git author's email address.
`commits[][url]`|`url` | URL that points to the commit API resource.
`commits[][distinct]`|`boolean` | Whether this commit is distinct from any that have been pushed before.
{% data reusables.webhooks.push_properties %}

## ReleaseEvent

Expand All @@ -265,18 +252,6 @@ Key | Type | Description
{% data reusables.webhooks.release_event_api_properties %}
{% data reusables.webhooks.release_properties %}

{% ifversion fpt or ghec %}

## SponsorshipEvent

{% data reusables.webhooks.sponsorship_short_desc %}

### Event `payload` object for SponsorshipEvent

{% data reusables.webhooks.sponsorship_event_api_properties %}
{% data reusables.webhooks.sponsorship_properties %}
{% endif %}

## WatchEvent

{% data reusables.webhooks.watch_short_desc %}
Expand Down
2 changes: 2 additions & 0 deletions data/reusables/webhooks/commit_comment_properties.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
Key | Type | Description
----|------|-------------
| {% ifversion fpt or ghec %} |
`action`|`string` | The action performed. Can be `created`.
| {% endif %} |
`comment`|`object` | The [commit comment](/rest/commits#get-a-commit-comment) resource.
5 changes: 4 additions & 1 deletion data/reusables/webhooks/create_properties.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
Key | Type | Description
----|------|-------------
`ref`|`string` | The [`git ref`](/rest/git#get-a-reference) resource, or `null` if `ref_type` is `repository`.
`ref`|`string` | The [`git ref`](/rest/git#get-a-reference) resource branch, or `null` if `ref_type` is `repository`.
`ref_type`|`string` | The type of Git ref object created in the repository. Can be either `branch`, `tag`, or `repository`.
| {% ifversion fpt or ghec %} |
`full_ref`|`string` | The fully-formed ref resource, meaning that for branches the format is `refs/heads/<branch_name>`.
| {% endif %} |
`master_branch`|`string` | The name of the repository's default branch (usually `main`).
`description`|`string` | The repository's current description.
`pusher_type`|`string` | Can be either `user` or a deploy key.
6 changes: 5 additions & 1 deletion data/reusables/webhooks/delete_properties.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
Key | Type | Description
----|------|-------------
`ref`|`string` | The [`git ref`](/rest/git#get-a-reference) resource.
`ref`|`string` | The [`git ref`](/rest/git#get-a-reference) resource branch.
`ref_type`|`string` | The type of Git ref object deleted in the repository. Can be either `branch` or `tag`.
| {% ifversion fpt or ghec %} |
`full_ref`|`string` | The fully-formed ref resource, meaning that for branches the format is `refs/heads/<branch_name>`.
| {% endif %} |
`pusher_type`|`string` | Can be either `user` or a deploy key.
4 changes: 4 additions & 0 deletions data/reusables/webhooks/discussion_properties.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Key | Type | Description
----|------|-------------
`action`|`string`| The action performed. Can be `created`.
`discussion`|`object`| The discussion that was created.
1 change: 1 addition & 0 deletions data/reusables/webhooks/discussion_short_desc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
A discussion is created in a repository. For more information, see [AUTOTITLE](/discussions).
3 changes: 3 additions & 0 deletions data/reusables/webhooks/fork_properties.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
Key | Type | Description
----|------|-------------
| {% ifversion fpt or ghec %} |
`action`|`string` | The action performed. Can be `forked`.
| {% endif %} |
`forkee`|`object` | The created [`repository`](/rest/repos#get-a-repository) resource.
1 change: 1 addition & 0 deletions data/reusables/webhooks/gollum_properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ Key | Type | Description
`pages`|`array` | The pages that were updated.
`pages[][page_name]`|`string` | The name of the page.
`pages[][title]`|`string` | The current page title.
`pages[][summary]`|`string` | An optional note about the page. Can be `null`.
`pages[][action]`|`string` | The action that was performed on the page. Can be `created` or `edited`.
`pages[][sha]`|`string` | The latest commit SHA of the page.
`pages[][html_url]`|`string` | Points to the HTML wiki page.
2 changes: 0 additions & 2 deletions data/reusables/webhooks/issue_comment_properties.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,2 @@
`changes`|`object` | The changes to the comment if the action was `edited`.
`changes[body][from]` |`string` | The previous version of the body if the action was `edited`.
`issue`|`object` | The [issue](/rest/issues) the comment belongs to.
`comment`|`object` | The [comment](/rest/issues#comments) itself.
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Key | Type | Description
----|------|-------------
`action`|`string` | The action that was performed on the comment. Can be one of `created`, `edited`, or `deleted`.
`action`|`string` | The action that was performed on the comment. Can be `created`.
6 changes: 5 additions & 1 deletion data/reusables/webhooks/issue_event_api_properties.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
Key | Type | Description
----|------|-------------
`action`|`string` | The action that was performed. Can be one of `opened`, `edited`, `closed`, `reopened`, `assigned`, `unassigned`, `labeled`, or `unlabeled`.
| {% ifversion fpt or ghec %} |
`action`|`string` | The action that was performed. Can be one of `opened`, `closed`, `reopened`.
| {% else %} |
`action`|`string` | The action that was performed. Can be one of `opened`, `closed`, `reopened`, `assigned`, `unassigned`, `labeled`, or `unlabeled`.
| {% endif %} |
7 changes: 4 additions & 3 deletions data/reusables/webhooks/issue_properties.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
`issue`|`object` | The [issue](/rest/issues) itself.
`changes`|`object`| The changes to the issue if the action was `edited`.
`changes[title][from]`|`string` | The previous version of the title if the action was `edited`.
`changes[body][from]`|`string` | The previous version of the body if the action was `edited`.
| {% ifversion fpt or ghec %} |
`assignee`|`object` | The optional user who was assigned or unassigned from the issue.
`assignees`|`array` | The optional array of assignee objects detailing the assignees on the issue.
`label`|`object` | The optional label that was added or removed from the issue.
`labels`|`array` | The optional array of label objects describing the labels on the issue.
| {% endif %} |
2 changes: 0 additions & 2 deletions data/reusables/webhooks/member_properties.md
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
`member`|`object` | The [user](/rest/users) that was added.
`changes`|`object`| The changes to the collaborator permissions if the action was `edited`.
`changes[old_permission][from]`|`string` | The previous permissions of the collaborator if the action was `edited`.
6 changes: 5 additions & 1 deletion data/reusables/webhooks/pull_request_event_api_properties.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
Key | Type | Description
----|------|-------------
`action`|`string` | The action that was performed. Can be one of `opened`, `edited`, `closed`, `reopened`, `assigned`, `unassigned`, `review_requested`, `review_request_removed`, `labeled`, `unlabeled`, and `synchronize`.
| {% ifversion fpt or ghec %} |
`action`|`string` | The action that was performed. Can be one of `opened`, `closed`, `reopened`, `assigned`, `unassigned`, `labeled`, and `unlabeled`.
| {% else %} |
`action`|`string` | The action that was performed. Can be one of `opened`, `closed`, `reopened`.
| {% endif %} |
12 changes: 7 additions & 5 deletions data/reusables/webhooks/pull_request_properties.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
`number`|`integer` | The pull request number.
`changes`|`object`| The changes to the comment if the action was `edited`.
`changes[title][from]`|`string` | The previous version of the title if the action was `edited`.
`changes[body][from]`|`string` | The previous version of the body if the action was `edited`.
`pull_request`|`object` | The [pull request](/rest/pulls) itself.{% ifversion fpt or ghec %}
`reason`|`string` | The reason the pull request was removed from a merge queue if the action was `dequeued`.{% endif %}
`pull_request`|`object` | The [pull request](/rest/pulls) itself.
| {% ifversion fpt or ghec %} |
`assignee`|`object` | The optional user who was assigned or unassigned from the issue.
`assignees`|`array` | The optional array of assignee objects detailing the assignees on the issue.
`label`|`object` | The optional label that was added or removed from the issue if the action was `labeled` or `unlabeled`.
`labels`|`array` | The optional array of label objects describing the labels on the pull request if the action was `labeled` or `unlabeled`.
| {% endif %} |
Original file line number Diff line number Diff line change
@@ -1,4 +1,2 @@
`changes`|`object`| The changes to the comment if the action was `edited`.
`changes[body][from]`|`string` | The previous version of the body if the action was `edited`.
`pull_request`|`object` | The [pull request](/rest/pulls) the comment belongs to.
`comment`|`object` | The [comment](/rest/pulls#comments) itself.
9 changes: 9 additions & 0 deletions data/reusables/webhooks/pull_request_review_properties.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Key | Type | Description
----|------|-------------
| {% ifversion fpt or ghec %} |
`action`|`string` | The action that was performed. Can be `created`, `updated`, or `dismissed`.
| {% else %} |
`action`|`string` | The action that was performed. Can be `created`.
| {% endif %} |
`pull_request`|`object` | The [pull request](/rest/pulls) the review pertains to.
`review`|`object` | The [review](/rest/pulls) that was affected.
21 changes: 21 additions & 0 deletions data/reusables/webhooks/push_properties.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Key | Type | Description
----|------|-------------
`repository_id`|`integer` | The unique identifier of the repository where the push occurred.
`push_id`|`integer` | The unique identifier for the push.
| {% ifversion ghes %} |
`size`|`integer` | The number of commits in the push.
`distinct_size`|`integer` | The number of distinct commits in the push.
| {% endif %} |
`ref`|`string` | The full [`git ref`](/rest/git/refs) that was pushed. Example: `refs/heads/main`.
`head`|`string` | The SHA of the most recent commit on `ref` after the push.
`before`|`string` | The SHA of the most recent commit on `ref` before the push.
| {% ifversion ghes %} |
`commits`|`array` | An array of commit objects describing the pushed commits. (The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](/rest/repos#commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.)
`commits[][sha]`|`string` | The SHA of the commit.
`commits[][message]`|`string` | The commit message.
`commits[][author]`|`object` | The git author of the commit.
`commits[][author][name]`|`string` | The git author's name.
`commits[][author][email]`|`string` | The git author's email address.
`commits[][url]`|`url` | URL that points to the commit API resource.
`commits[][distinct]`|`boolean` | Whether this commit is distinct from any that have been pushed before.
| {% endif %} |
2 changes: 0 additions & 2 deletions data/reusables/webhooks/release_properties.md
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
`changes[body][from]` |`string` | The previous version of the body if the action was `edited`.
`changes[name][from]` |`string` | The previous version of the name if the action was `edited`.
`release`|`object` | The [release](/rest/releases/releases#get-a-release) object.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export const codeAnnotationCommentSpacing = {
description:
'Code comments in annotation blocks must have exactly one space after the comment character(s)',
tags: ['code', 'comments', 'annotate', 'spacing'],
parser: 'markdownit',
parser: 'markdownit' as const,
function: (params: RuleParams, onError: RuleErrorCallback) => {
filterTokens(params, 'fence', (token: MarkdownToken) => {
if (!token.info?.includes('annotate')) return
Expand Down
Loading
Loading