Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 99c927c

Browse files
author
Sarah Edwards
authored
update titles for REST API commits, deploy keys, deployments docs (#49512)
1 parent 1ab862e commit 99c927c

17 files changed

Lines changed: 30 additions & 19 deletions

File tree

‎content/actions/using-workflows/events-that-trigger-workflows.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ on:
175175

176176
{% endnote %}
177177

178-
Runs your workflow when a third party provides a deployment status. Deployments created with a commit SHA may not have a Git ref. For information about the APIs to create a deployment status, see "[AUTOTITLE](/graphql/reference/mutations#createdeploymentstatus)" in the GraphQL API documentation or "[AUTOTITLE](/rest/deployments#create-a-deployment-status)" in the REST API documentation.
178+
Runs your workflow when a third party provides a deployment status. Deployments created with a commit SHA may not have a Git ref. For information about the APIs to create a deployment status, see "[AUTOTITLE](/graphql/reference/mutations#createdeploymentstatus)" in the GraphQL API documentation or "[AUTOTITLE](/rest/deployments#create-a-deployment-status)."
179179

180180
For example, you can run a workflow when the `deployment_status` event occurs.
181181

@@ -931,7 +931,7 @@ jobs:
931931

932932
{% note %}
933933

934-
**Note:** The webhook payload available to GitHub Actions does not include the `added`, `removed`, and `modified` attributes in the `commit` object. You can retrieve the full commit object using the API. For information, see "[AUTOTITLE](/graphql/reference/objects#commit)" in the GraphQL API documentation or "[AUTOTITLE](/rest/commits#get-a-commit)" in the REST API documentation.
934+
**Note:** The webhook payload available to GitHub Actions does not include the `added`, `removed`, and `modified` attributes in the `commit` object. You can retrieve the full commit object using the API. For information, see "[AUTOTITLE](/graphql/reference/objects#commit)" in the GraphQL API documentation or "[AUTOTITLE](/rest/commits#get-a-commit)."
935935

936936
{% endnote %}
937937

@@ -1215,7 +1215,7 @@ Notifications for scheduled workflows are sent to the user who last modified the
12151215

12161216
{% data reusables.actions.branch-requirement %}
12171217

1218-
Runs your workflow when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. If you want to provide more details about the status change, you may want to use the [`check_run`](#check_run) event. For information about the commit status APIs, see "[AUTOTITLE](/graphql/reference/objects#status)" in the GraphQL API documentation or "[AUTOTITLE](/rest/commits#commit-statuses)" in the REST API documentation.
1218+
Runs your workflow when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. If you want to provide more details about the status change, you may want to use the [`check_run`](#check_run) event. For information about the commit status APIs, see "[AUTOTITLE](/graphql/reference/objects#status)" in the GraphQL API documentation or "[AUTOTITLE](/rest/commits#commit-statuses)."
12191219

12201220
For example, you can run a workflow when the `status` event occurs.
12211221

‎content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ The `$GITHUB_VIA` variable is available in the pre-receive hook environment when
8484

8585
| Value | Action | More information |
8686
| :- | :- | :- |
87-
| <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 |
87+
| <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)" |
8888
| <pre>blob#save</pre> | Change to a file's contents in the web interface | "[AUTOTITLE](/repositories/working-with-files/managing-files/editing-files)" |
8989
| <pre>branch merge api</pre> | Merge of a branch via the API | "[AUTOTITLE](/rest/branches#merge-a-branch)" |
9090
| <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)" |

‎content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ For complex pull requests that require many reviews, requiring an approval from
109109

110110
Required status checks ensure that all required CI tests are either passing or skipped before collaborators can make changes to a protected branch. Required status checks can be checks or statuses. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)."
111111

112-
You can use the commit status API to allow external services to mark commits with an appropriate status. For more information, see "[AUTOTITLE](/rest/commits/statuses)" in the REST API documentation.
112+
You can use the commit status API to allow external services to mark commits with an appropriate status. For more information, see "[AUTOTITLE](/rest/commits/statuses)."
113113

114114
After enabling required status checks, all required status checks must pass before collaborators can merge changes into the protected branch. After all required status checks pass, any commits must either be pushed to another branch and then merged or pushed directly to the protected branch.
115115

‎content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ Optionally, you can require all comments on the pull request to be resolved befo
138138

139139
Required status checks ensure that all required CI tests are passing before collaborators can make changes to a branch or tag targeted by your ruleset. Required status checks can be checks or statuses. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)."
140140

141-
You can use the commit status API to allow external services to mark commits with an appropriate status. For more information, see "[AUTOTITLE](/rest/commits/statuses)" in the REST API documentation.
141+
You can use the commit status API to allow external services to mark commits with an appropriate status. For more information, see "[AUTOTITLE](/rest/commits/statuses)."
142142

143143
After enabling required status checks, all required status checks must pass before collaborators can merge changes into the branch or tag.
144144

‎content/rest/commits/comments.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: Commit comments
2+
title: REST API endpoints for commit comments
3+
shortTitle: Commit comments
34
intro: Use the REST API to interact with commit comments.
45
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
56
fpt: '*'

‎content/rest/commits/commits.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
2-
title: Commits
2+
title: REST API endpoints for commits
3+
shortTitle: Commits
4+
allowTitleToDifferFromFilename: true
35
intro: Use the REST API to interact with commits.
46
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
57
fpt: '*'

‎content/rest/commits/index.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: Commits
2+
title: REST API endpoints for commits
3+
shortTitle: Commits
34
intro: Use the REST API to interact with commits.
45
allowTitleToDifferFromFilename: true
56
versions:

‎content/rest/commits/statuses.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: Commit statuses
2+
title: REST API endpoints for commit statuses
3+
shortTitle: Commit statuses
34
intro: Use the REST API to interact with commit statuses.
45
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
56
fpt: '*'

‎content/rest/deploy-keys/deploy-keys.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: Deploy keys
2+
title: REST API endpoints for deploy keys
3+
shortTitle: Deploy keys
34
intro: Use the REST API to create and manage deploy keys.
45
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
56
fpt: '*'

‎content/rest/deploy-keys/index.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: Deploy keys
2+
title: REST API endpoints for deploy keys
3+
shortTitle: Deploy keys
34
intro: Use the REST API to create and manage deploy keys.
45
versions:
56
fpt: '*'

0 commit comments

Comments
 (0)