Skip to content

Commit 3b4454e

Browse files
authored
Merge pull request github#17426 from github/repo-sync
repo sync
2 parents a6a95d4 + 3434d4f commit 3b4454e

File tree

48 files changed

+470
-281
lines changed

Some content is hidden

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

48 files changed

+470
-281
lines changed

content/rest/actions/artifacts.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
2-
title: Artifacts
3-
intro: 'The Artifacts API allows you to download, delete, and retrieve information about workflow artifacts.'
2+
title: GitHub Actions Artifacts
3+
allowTitleToDifferFromFilename: true
4+
shortTitle: Artifacts
5+
intro: 'The {% data variables.product.prodname_actions %} Artifacts API allows you to download, delete, and retrieve information about workflow artifacts.'
46
topics:
57
- API
68
versions:
@@ -10,6 +12,8 @@ versions:
1012
ghec: '*'
1113
---
1214

13-
{% data reusables.actions.about-artifacts %} For more information, see "[Persisting workflow data using artifacts](/actions/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)."
15+
## About the Artifacts API
16+
17+
The {% data variables.product.prodname_actions %} Artifacts API allows you to download, delete, and retrieve information about workflow artifacts. {% data reusables.actions.about-artifacts %} For more information, see "[Persisting workflow data using artifacts](/actions/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)."
1418

1519
{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %}

content/rest/actions/cache.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
---
2-
title: Cache
3-
intro: 'The Cache API allows you to query and manage the {% data variables.product.prodname_actions %} cache for repositories.'
2+
title: GitHub Actions Cache
3+
allowTitleToDifferFromFilename: true
4+
shortTitle: Cache
5+
intro: 'The {% data variables.product.prodname_actions %} Cache API allows you to query and manage the {% data variables.product.prodname_actions %} cache for repositories.'
46
topics:
57
- API
68
versions:
79
fpt: '*'
810
ghec: '*'
911
---
1012

11-
The cache API allows you to query and manage the {% data variables.product.prodname_actions %} cache for repositories. For more information, see "[Caching dependencies to speed up workflows](/actions/advanced-guides/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy)."
13+
## About the Cache API
14+
15+
The {% data variables.product.prodname_actions %} Cache API allows you to query and manage the {% data variables.product.prodname_actions %} cache for repositories. For more information, see "[Caching dependencies to speed up workflows](/actions/advanced-guides/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy)."

content/rest/actions/permissions.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
2-
title: Permissions
3-
intro: 'The Permissions API allows you to set permissions for what enterprises, organizations, and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions{% if actions-workflow-policy %} and reusable workflows{% endif %} are allowed to run.'
2+
title: GitHub Actions Permissions
3+
allowTitleToDifferFromFilename: true
4+
shortTitle: Permissions
5+
intro: 'The {% data variables.product.prodname_actions %} Permissions API allows you to set permissions for what enterprises, organizations, and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions{% if actions-workflow-policy %} and reusable workflows{% endif %} are allowed to run.'
46
topics:
57
- API
68
versions:
@@ -10,6 +12,6 @@ versions:
1012
ghec: '*'
1113
---
1214

13-
## Permissions
15+
## About the Permissions API
1416

15-
The Permissions API allows you to set permissions for what enterprises, organizations, and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions{% if actions-workflow-policy %} and reusable workflows{% endif %} are allowed to run.{% ifversion fpt or ghec or ghes %} For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#disabling-or-limiting-github-actions-for-your-repository-or-organization)."{% endif %}
17+
The {% data variables.product.prodname_actions %} Permissions API allows you to set permissions for what enterprises, organizations, and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions{% if actions-workflow-policy %} and reusable workflows{% endif %} are allowed to run.{% ifversion fpt or ghec or ghes %} For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#disabling-or-limiting-github-actions-for-your-repository-or-organization)."{% endif %}

content/rest/actions/secrets.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
2-
title: Secrets
3-
intro: 'The Secrets API lets you create, update, delete, and retrieve information about encrypted secrets. '
2+
title: GitHub Actions Secrets
3+
allowTitleToDifferFromFilename: true
4+
shortTitle: Secrets
5+
intro: 'The {% data variables.product.prodname_actions %} Secrets API lets you create, update, delete, and retrieve information about encrypted secrets that can be used in {% data variables.product.prodname_actions %} workflows.'
46
topics:
57
- API
68
versions:
@@ -10,6 +12,8 @@ versions:
1012
ghec: '*'
1113
---
1214

13-
{% data reusables.actions.about-secrets %} For more information, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)."
15+
## About the Secrets API
16+
17+
The {% data variables.product.prodname_actions %} Secrets API lets you create, update, delete, and retrieve information about encrypted secrets that can be used in {% data variables.product.prodname_actions %} workflows. {% data reusables.actions.about-secrets %} For more information, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)."
1418

1519
{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `secrets` permission to use this API. Authenticated users must have collaborator access to a repository to create, update, or read secrets.

content/rest/actions/self-hosted-runner-groups.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ versions:
1010
ghec: '*'
1111
---
1212

13-
## Self-hosted runner groups
13+
## About the Self-hosted runner groups API
1414

15-
The Self-hosted Runners Groups API allows you manage groups of self-hosted runners. For more information, see "[Managing access to self-hosted runners using groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)."
15+
The Self-hosted runners groups API allows you manage groups of self-hosted runners. For more information, see "[Managing access to self-hosted runners using groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)."
1616

1717
{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `administration` permission for repositories or the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises to use this API.
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Self-hosted runners
3-
intro: 'The Self-hosted Runners API allows you to register, view, and delete self-hosted runners.'
3+
intro: 'The Self-hosted runners API allows you to register, view, and delete self-hosted runners.'
44
topics:
55
- API
66
versions:
@@ -10,8 +10,8 @@ versions:
1010
ghec: '*'
1111
---
1212

13-
## Self-hosted runners
13+
## About the Self-hosted runners API
1414

15-
The Self-hosted Runners API allows you to register, view, and delete self-hosted runners. {% data reusables.actions.about-self-hosted-runners %} For more information, see "[Hosting your own runners](/actions/hosting-your-own-runners)."
15+
The Self-hosted runners API allows you to register, view, and delete self-hosted runners. {% data reusables.actions.about-self-hosted-runners %} For more information, see "[Hosting your own runners](/actions/hosting-your-own-runners)."
1616

1717
{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `administration` permission for repositories the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises to use this API.

content/rest/actions/workflow-jobs.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ versions:
1010
ghec: '*'
1111
---
1212

13-
{% data reusables.actions.about-workflow-jobs %} For more information, see "[Workflow syntax for GitHub Actions](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions)".
13+
## About the Workflow jobs API
14+
15+
The Workflow jobs API allows you to view logs and workflow jobs. {% data reusables.actions.about-workflow-jobs %} For more information, see "[Workflow syntax for GitHub Actions](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions)".
1416

1517
{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %}

content/rest/actions/workflow-runs.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Workflow runs
3-
intro: 'The Workflow Runs API allows you to view, re-run, cancel, and view logs for workflow runs.'
3+
intro: 'The Workflow runs API allows you to view, re-run, cancel, and view logs for workflow runs.'
44
topics:
55
- API
66
versions:
@@ -10,6 +10,8 @@ versions:
1010
ghec: '*'
1111
---
1212

13-
{% data reusables.actions.about-workflow-runs %} For more information, see "[Managing a workflow run](/actions/automating-your-workflow-with-github-actions/managing-a-workflow-run)."
13+
## About the Workflow runs API
14+
15+
The Workflow runs API allows you to view, re-run, cancel, and view logs for workflow runs. {% data reusables.actions.about-workflow-runs %} For more information, see "[Managing a workflow run](/actions/automating-your-workflow-with-github-actions/managing-a-workflow-run)."
1416

1517
{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %}

content/rest/actions/workflows.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ versions:
1010
ghec: '*'
1111
---
1212

13-
{% data reusables.actions.about-workflows %} For more information, see "[Automating your workflow with GitHub Actions](/actions/automating-your-workflow-with-github-actions)."
13+
## About the Workflows API
14+
15+
The Workflows API allows you to view workflows for a repository. {% data reusables.actions.about-workflows %} For more information, see "[Automating your workflow with GitHub Actions](/actions/automating-your-workflow-with-github-actions)."
1416

1517
{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %}

content/rest/activity/feeds.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ topics:
1111
miniTocMaxHeadingLevel: 3
1212
---
1313

14+
## About the Feeds API
15+
16+
To see what feeds are available to you, use the [Get feeds](#get-feeds) operation. You can then get a feed by sending a request to one of the feed URLs.
17+
1418
### Example of getting an Atom feed
1519

1620
To get a feed in Atom format, you must specify the `application/atom+xml` type in the `Accept` header. For example, to get the Atom feed for GitHub security advisories:

0 commit comments

Comments
 (0)