Skip to content

Commit 2b7ddc0

Browse files
authored
Merge pull request #40873 from github/repo-sync
Repo sync
2 parents 97ba664 + db8ac67 commit 2b7ddc0

File tree

50 files changed

+1281087
-297051
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+1281087
-297051
lines changed

content/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ See the [contributing docs](https://docs.github.com/en/contributing) for general
2525
- [`defaultTool`](#defaulttool)
2626
- [`learningTracks`](#learningtracks)
2727
- [`includeGuides`](#includeguides)
28+
- [`journeyTracks`](#journeytracks)
2829
- [`type`](#type)
2930
- [`topics`](#topics)
3031
- [`communityRedirect`](#communityRedirect)
@@ -252,6 +253,35 @@ includeGuides:
252253
- /actions/guides/building-and-testing-powershell
253254
```
254255

256+
### `journeyTracks`
257+
- Purpose: Define journeys for journey landing pages.
258+
- Type: `Array` of objects with the following properties:
259+
- `id` (required): Unique identifier for the journey. The id only needs to be unique for journeys within a single journey landing page.
260+
- `title` (required): Display title for the journey (supports Liquid variables)
261+
- `description` (optional): Description of the journey (supports Liquid variables)
262+
- `guides` (required): Array of article paths that make up this journey
263+
- Only applicable when used with `layout: journey-landing`.
264+
- Optional.
265+
266+
Example:
267+
268+
```yaml
269+
journeyTracks:
270+
- id: 'getting_started'
271+
title: 'Getting started with {% data variables.product.prodname_actions %}'
272+
description: 'Learn the basics of GitHub Actions.'
273+
guides:
274+
- '/actions/quickstart'
275+
- '/actions/learn-github-actions'
276+
- '/actions/using-workflows'
277+
- id: 'advanced'
278+
title: 'Advanced {% data variables.product.prodname_actions %}'
279+
description: 'Dive deeper into advanced features.'
280+
guides:
281+
- '/actions/using-workflows/workflow-syntax-for-github-actions'
282+
- '/actions/deployment/deploying-with-github-actions'
283+
```
284+
255285
### `type`
256286
- Purpose: Indicate the type of article.
257287
- Type: `String`, one of the `overview`, `quick_start`, `tutorial`, `how_to`, `reference`.

content/contributing/writing-for-github-docs/using-yaml-frontmatter.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ For more information, see [`lib/frontmatter.js`](https://github.com/github/docs/
3939
* [`defaultTool`](#defaulttool)
4040
* [`learningTracks`](#learningtracks)
4141
* [`includeGuides`](#includeguides)
42+
* [`journeyTracks`](#journeytracks)
4243
* [`type`](#type)
4344
* [`topics`](#topics)
4445
* [`communityRedirect`](#communityredirect)
@@ -249,6 +250,36 @@ includeGuides:
249250
- /actions/guides/building-and-testing-powershell
250251
```
251252

253+
### `journeyTracks`
254+
255+
* Purpose: Define journeys for journey landing pages.
256+
* Type: `Array` of objects with the following properties:
257+
* `id` (required): Unique identifier for the journey. The id only needs to be unique for journeys within a single journey landing page.
258+
* `title` (required): Display title for the journey (supports Liquid variables)
259+
* `description` (optional): Description of the journey (supports Liquid variables)
260+
* `guides` (required): Array of article paths that make up this journey
261+
* Only applicable when used with `layout: journey-landing`.
262+
* Optional.
263+
264+
Example:
265+
266+
```yaml
267+
journeyTracks:
268+
- id: 'getting_started'
269+
title: 'Getting started with {% data variables.product.prodname_actions %}'
270+
description: 'Learn the basics of GitHub Actions.'
271+
guides:
272+
- '/actions/quickstart'
273+
- '/actions/learn-github-actions'
274+
- '/actions/using-workflows'
275+
- id: 'advanced'
276+
title: 'Advanced {% data variables.product.prodname_actions %}'
277+
description: 'Dive deeper into advanced features.'
278+
guides:
279+
- '/actions/using-workflows/workflow-syntax-for-github-actions'
280+
- '/actions/deployment/deploying-with-github-actions'
281+
```
282+
252283
### `type`
253284

254285
* Purpose: Indicate the type of article.

content/rest/using-the-rest-api/github-event-types.md

Lines changed: 28 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -63,31 +63,33 @@ Link: <https://api.github.com/resource?page=2>; rel="next",
6363
```json
6464
[
6565
{
66+
"id": "12345",
6667
"type": "WatchEvent",
67-
"public": false,
68-
"payload": {
68+
"actor": {
69+
"id": 1,
70+
"login": "octocat",
71+
"display_login": "octocat",
72+
"gravatar_id": "",
73+
"url": "https://api.github.com/users/octocat",
74+
"avatar_url": "https://github.com/images/error/octocat_happy.gif"
6975
},
7076
"repo": {
7177
"id": 3,
7278
"name": "octocat/Hello-World",
7379
"url": "https://api.github.com/repos/octocat/Hello-World"
7480
},
75-
"actor": {
76-
"id": 1,
77-
"login": "octocat",
78-
"gravatar_id": "",
79-
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
80-
"url": "https://api.github.com/users/octocat"
81+
"payload": {
82+
"action": "started"
8183
},
84+
"public": false,
85+
"created_at": "2011-09-06T17:26:27Z",
8286
"org": {
8387
"id": 1,
8488
"login": "github",
8589
"gravatar_id": "",
8690
"url": "https://api.github.com/orgs/github",
8791
"avatar_url": "https://github.com/images/error/octocat_happy.gif"
8892
},
89-
"created_at": "2011-09-06T17:26:27Z",
90-
"id": "12345"
9193
}
9294
]
9395
```
@@ -122,6 +124,20 @@ Link: <https://api.github.com/resource?page=2>; rel="next",
122124

123125
{% data reusables.webhooks.delete_properties %}
124126

127+
{% ifversion fpt or ghec %}
128+
129+
## DiscussionEvent
130+
131+
{% data reusables.webhooks.discussion_short_desc %}
132+
133+
{% data reusables.webhooks.events_api_payload %}
134+
135+
### Event `payload` object for DiscussionEvent
136+
137+
{% data reusables.webhooks.discussion_properties %}
138+
139+
{% endif %}
140+
125141
## ForkEvent
126142

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

203219
### Event `payload` object for PullRequestReviewEvent
204220

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

211223
## PullRequestReviewCommentEvent
212224

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

222-
## PullRequestReviewThreadEvent
223-
224-
{% data reusables.webhooks.pull_request_review_thread_short_desc %}
225-
226-
{% data reusables.webhooks.events_api_payload %}
227-
228-
### Event `payload` object for PullRequestReviewThreadEvent
229-
230-
{% data reusables.webhooks.pull_request_thread_properties %}
231-
232234
## PushEvent
233235

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

238240
### Event `payload` object for PushEvent
239241

240-
Key | Type | Description
241-
----|------|-------------
242-
`push_id` | `integer` | Unique identifier for the push.
243-
`size`|`integer` | The number of commits in the push.
244-
`distinct_size`|`integer` | The number of distinct commits in the push.
245-
`ref`|`string` | The full [`git ref`](/rest/git/refs) that was pushed. Example: `refs/heads/main`.
246-
`head`|`string` | The SHA of the most recent commit on `ref` after the push.
247-
`before`|`string` | The SHA of the most recent commit on `ref` before the push.
248-
`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.)
249-
`commits[][sha]`|`string` | The SHA of the commit.
250-
`commits[][message]`|`string` | The commit message.
251-
`commits[][author]`|`object` | The git author of the commit.
252-
`commits[][author][name]`|`string` | The git author's name.
253-
`commits[][author][email]`|`string` | The git author's email address.
254-
`commits[][url]`|`url` | URL that points to the commit API resource.
255-
`commits[][distinct]`|`boolean` | Whether this commit is distinct from any that have been pushed before.
242+
{% data reusables.webhooks.push_properties %}
256243

257244
## ReleaseEvent
258245

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

268-
{% ifversion fpt or ghec %}
269-
270-
## SponsorshipEvent
271-
272-
{% data reusables.webhooks.sponsorship_short_desc %}
273-
274-
### Event `payload` object for SponsorshipEvent
275-
276-
{% data reusables.webhooks.sponsorship_event_api_properties %}
277-
{% data reusables.webhooks.sponsorship_properties %}
278-
{% endif %}
279-
280255
## WatchEvent
281256

282257
{% data reusables.webhooks.watch_short_desc %}
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
Key | Type | Description
22
----|------|-------------
3+
| {% ifversion fpt or ghec %} |
34
`action`|`string` | The action performed. Can be `created`.
5+
| {% endif %} |
46
`comment`|`object` | The [commit comment](/rest/commits#get-a-commit-comment) resource.
Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
Key | Type | Description
22
----|------|-------------
3-
`ref`|`string` | The [`git ref`](/rest/git#get-a-reference) resource, or `null` if `ref_type` is `repository`.
3+
`ref`|`string` | The [`git ref`](/rest/git#get-a-reference) resource branch, or `null` if `ref_type` is `repository`.
44
`ref_type`|`string` | The type of Git ref object created in the repository. Can be either `branch`, `tag`, or `repository`.
5+
| {% ifversion fpt or ghec %} |
6+
`full_ref`|`string` | The fully-formed ref resource, meaning that for branches the format is `refs/heads/<branch_name>`.
7+
| {% endif %} |
58
`master_branch`|`string` | The name of the repository's default branch (usually `main`).
69
`description`|`string` | The repository's current description.
710
`pusher_type`|`string` | Can be either `user` or a deploy key.
Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
Key | Type | Description
22
----|------|-------------
3-
`ref`|`string` | The [`git ref`](/rest/git#get-a-reference) resource.
3+
`ref`|`string` | The [`git ref`](/rest/git#get-a-reference) resource branch.
44
`ref_type`|`string` | The type of Git ref object deleted in the repository. Can be either `branch` or `tag`.
5+
| {% ifversion fpt or ghec %} |
6+
`full_ref`|`string` | The fully-formed ref resource, meaning that for branches the format is `refs/heads/<branch_name>`.
7+
| {% endif %} |
8+
`pusher_type`|`string` | Can be either `user` or a deploy key.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Key | Type | Description
2+
----|------|-------------
3+
`action`|`string`| The action performed. Can be `created`.
4+
`discussion`|`object`| The discussion that was created.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
A discussion is created in a repository. For more information, see [AUTOTITLE](/discussions).
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
Key | Type | Description
22
----|------|-------------
3+
| {% ifversion fpt or ghec %} |
4+
`action`|`string` | The action performed. Can be `forked`.
5+
| {% endif %} |
36
`forkee`|`object` | The created [`repository`](/rest/repos#get-a-repository) resource.

data/reusables/webhooks/gollum_properties.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ Key | Type | Description
33
`pages`|`array` | The pages that were updated.
44
`pages[][page_name]`|`string` | The name of the page.
55
`pages[][title]`|`string` | The current page title.
6+
`pages[][summary]`|`string` | An optional note about the page. Can be `null`.
67
`pages[][action]`|`string` | The action that was performed on the page. Can be `created` or `edited`.
78
`pages[][sha]`|`string` | The latest commit SHA of the page.
89
`pages[][html_url]`|`string` | Points to the HTML wiki page.

0 commit comments

Comments
 (0)