Skip to content

Commit

Permalink
autogenerate frontmatter (#34744)
Browse files Browse the repository at this point in the history
  • Loading branch information
rachmari authored Feb 14, 2023
1 parent dda821b commit 8d3eb29
Show file tree
Hide file tree
Showing 185 changed files with 722 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ versions:
topics:
- Webhooks
shortTitle: Webhook events & payloads
autogenerated: true
---

{% data reusables.webhooks.webhooks_intro %}
Expand Down Expand Up @@ -97,4 +98,5 @@ Also, the `User-Agent` for the requests will have the prefix `GitHub-Hookshot/`.
> }
```
<!-- Content after this section is automatically generated -->
4 changes: 4 additions & 0 deletions content/graphql/overview/breaking-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ versions:
ghae: '*'
topics:
- API
autogenerated: true
---

## About breaking changes
Expand All @@ -22,3 +23,6 @@ Breaking changes are any changes that might require action from our integrators.
We strive to provide stable APIs for our integrators. When a new feature is still evolving, we release it behind a [schema preview](/graphql/overview/schema-previews).

We'll announce upcoming breaking changes at least three months before making changes to the GraphQL schema, to give integrators time to make the necessary adjustments. Changes go into effect on the first day of a quarter (January 1st, April 1st, July 1st, or October 1st). For example, if we announce a change on January 15th, it will be made on July 1st.


<!-- Content after this section is automatically generated -->
4 changes: 4 additions & 0 deletions content/graphql/overview/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ versions:
ghae: '*'
topics:
- API
autogenerated: true
---

Breaking changes include changes that will break existing queries or could affect the runtime behavior of clients. For a list of breaking changes and when they will occur, see our [breaking changes log](/graphql/overview/breaking-changes).


<!-- Content after this section is automatically generated -->
4 changes: 4 additions & 0 deletions content/graphql/overview/schema-previews.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ versions:
ghae: '*'
topics:
- API
autogenerated: true
---

## About schema previews
Expand All @@ -23,3 +24,6 @@ To access a schema preview, you'll need to provide a custom [media type](/rest/o
**Note:** The GraphQL schema members under preview cannot be accessed via the Explorer at this time.

{% endnote %}


<!-- Content after this section is automatically generated -->
2 changes: 2 additions & 0 deletions content/graphql/reference/enums.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ versions:
ghae: '*'
topics:
- API
autogenerated: true
---

## About enums
Expand All @@ -23,4 +24,5 @@ For more information, see "[Introduction to GraphQL](/graphql/guides/introductio

{% data reusables.projects.graphql-ghes %}


<!-- Content after this section is automatically generated -->
4 changes: 4 additions & 0 deletions content/graphql/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,9 @@ children:
- /unions
- /input-objects
- /scalars
autogenerated: true
---



<!-- Content after this section is automatically generated -->
2 changes: 2 additions & 0 deletions content/graphql/reference/input-objects.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ versions:
ghae: '*'
topics:
- API
autogenerated: true
---

## About input objects
Expand All @@ -23,4 +24,5 @@ For more information, see "[About mutations](/graphql/guides/forming-calls-with-

{% data reusables.projects.graphql-ghes %}


<!-- Content after this section is automatically generated -->
2 changes: 2 additions & 0 deletions content/graphql/reference/interfaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ versions:
ghae: '*'
topics:
- API
autogenerated: true
---

## About interfaces
Expand All @@ -23,4 +24,5 @@ For more information, see "[Implementation](/graphql/guides/introduction-to-grap

{% data reusables.projects.graphql-ghes %}


<!-- Content after this section is automatically generated -->
2 changes: 2 additions & 0 deletions content/graphql/reference/mutations.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ versions:
ghae: '*'
topics:
- API
autogenerated: true
---

## About mutations
Expand All @@ -21,4 +22,5 @@ For more information, see "[About mutations](/graphql/guides/forming-calls-with-

{% data reusables.projects.graphql-ghes %}


<!-- Content after this section is automatically generated -->
2 changes: 2 additions & 0 deletions content/graphql/reference/objects.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ versions:
ghae: '*'
topics:
- API
autogenerated: true
---

## About objects
Expand All @@ -23,4 +24,5 @@ For more information, see "[Introduction to GraphQL](/graphql/guides/introductio

{% data reusables.projects.graphql-ghes %}


<!-- Content after this section is automatically generated -->
2 changes: 2 additions & 0 deletions content/graphql/reference/queries.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ versions:
ghae: '*'
topics:
- API
autogenerated: true
---

## About queries
Expand All @@ -26,4 +27,5 @@ For more information, see "[About queries](/graphql/guides/forming-calls-with-gr

{% endnote %}


<!-- Content after this section is automatically generated -->
2 changes: 2 additions & 0 deletions content/graphql/reference/scalars.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ versions:
ghae: '*'
topics:
- API
autogenerated: true
---

## About scalars
Expand All @@ -21,4 +22,5 @@ When calling the GraphQL API, you must specify nested subfields until you return

For more information, see "[Introduction to GraphQL](/graphql/guides/introduction-to-graphql#field)."


<!-- Content after this section is automatically generated -->
2 changes: 2 additions & 0 deletions content/graphql/reference/unions.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ versions:
ghae: '*'
topics:
- API
autogenerated: true
---

## About unions
Expand All @@ -23,4 +24,5 @@ For more information, see "[Introduction to GraphQL](/graphql/guides/introductio

{% data reusables.projects.graphql-ghes %}


<!-- Content after this section is automatically generated -->
4 changes: 4 additions & 0 deletions content/rest/actions/artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,14 @@ versions:
ghes: '*'
ghae: '*'
ghec: '*'
autogenerated: true
---

## About artifacts in {% data variables.product.prodname_actions %}

You can use the REST API to download, delete, and retrieve information about workflow artifacts in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-artifacts %} For more information, see "[Storing workflow data as artifacts](/actions/using-workflows/storing-workflow-data-as-artifacts)."

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


<!-- Content after this section is automatically generated -->
4 changes: 4 additions & 0 deletions content/rest/actions/cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,12 @@ versions:
fpt: '*'
ghec: '*'
ghes: '>3.4'
autogenerated: true
---

## About the cache in {% data variables.product.prodname_actions %}

You can use the REST API to query and manage the cache for repositories in {% data variables.product.prodname_actions %}. {% ifversion actions-cache-management %}You can also install a {% data variables.product.prodname_cli %} extension to manage your caches from the command line. {% endif %}For more information, see "[Caching dependencies to speed up workflows](/actions/advanced-guides/caching-dependencies-to-speed-up-workflows#managing-caches)."


<!-- Content after this section is automatically generated -->
5 changes: 5 additions & 0 deletions content/rest/actions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,10 @@ children:
- /workflow-jobs
- /workflow-runs
- /workflows
autogenerated: true
---

You can use the REST API to manage and control {% data variables.product.prodname_actions %} for an organization or repository. {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} require the permissions mentioned in each endpoint. For more information, see "[{% data variables.product.prodname_actions %} Documentation](/actions)."


<!-- Content after this section is automatically generated -->
4 changes: 4 additions & 0 deletions content/rest/actions/oidc.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,9 @@ versions:
fpt: '*'
ghec: '*'
ghes: '>=3.7'
autogenerated: true
---



<!-- Content after this section is automatically generated -->
4 changes: 4 additions & 0 deletions content/rest/actions/permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,12 @@ versions:
ghes: '*'
ghae: '*'
ghec: '*'
autogenerated: true
---

## About permissions for {% data variables.product.prodname_actions %}

You can use the REST API to set permissions for the {% ifversion ghes or ghec or ghae %}enterprises, {% endif %}organizations and repositories that are allowed to run {% data variables.product.prodname_actions %}, and the actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} that 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 after this section is automatically generated -->
4 changes: 4 additions & 0 deletions content/rest/actions/required-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,9 @@ versions:
fpt: '*'
ghec: '*'
ghes: '>=3.8'
autogenerated: true
---



<!-- Content after this section is automatically generated -->
4 changes: 4 additions & 0 deletions content/rest/actions/secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,14 @@ versions:
ghes: '*'
ghae: '*'
ghec: '*'
autogenerated: true
---

## About secrets in {% data variables.product.prodname_actions %}

You can use the REST API to create, update, delete, and retrieve information about encrypted secrets that can be used in workflows in {% data variables.product.prodname_actions %}. {% 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)."

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


<!-- Content after this section is automatically generated -->
4 changes: 4 additions & 0 deletions content/rest/actions/self-hosted-runner-groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,14 @@ versions:
ghes: '*'
ghae: '*'
ghec: '*'
autogenerated: true
---

## About self-hosted runner groups in {% data variables.product.prodname_actions %}

You can use the REST API to manage groups of self-hosted runners in {% data variables.product.prodname_actions %}. 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)."

{% 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 these endpoints.


<!-- Content after this section is automatically generated -->
6 changes: 5 additions & 1 deletion content/rest/actions/self-hosted-runners.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,14 @@ versions:
ghes: '*'
ghae: '*'
ghec: '*'
autogenerated: true
---

## About self-hosted runners in {% data variables.product.prodname_actions %}

You can use the REST API to register, view, and delete self-hosted runners in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-self-hosted-runners %} For more information, see "[Hosting your own runners](/actions/hosting-your-own-runners)."

{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `administration` permission for repositories and 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 these endpoints.


<!-- Content after this section is automatically generated -->
4 changes: 4 additions & 0 deletions content/rest/actions/variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,14 @@ versions:
fpt: '*'
ghes: '>=3.8'
ghec: '*'
autogenerated: true
---

## About variables in {% data variables.product.prodname_actions %}

You can use the REST API to create, update, delete, and retrieve information about variables that can be used in workflows in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-variables %}

{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `actions_variables/environments/organization_actions_variables` permission to use these endpoints. Authenticated users must have collaborator access to a repository to create, update, or read variables.


<!-- Content after this section is automatically generated -->
4 changes: 4 additions & 0 deletions content/rest/actions/workflow-jobs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,14 @@ versions:
ghes: '*'
ghae: '*'
ghec: '*'
autogenerated: true
---

## About workflow jobs in {% data variables.product.prodname_actions %}

You can use the REST API to view logs and workflow jobs in {% data variables.product.prodname_actions %}. {% 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)".

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


<!-- Content after this section is automatically generated -->
4 changes: 4 additions & 0 deletions content/rest/actions/workflow-runs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,14 @@ versions:
ghes: '*'
ghae: '*'
ghec: '*'
autogenerated: true
---

## About workflow runs in {% data variables.product.prodname_actions %}

You can use the REST API to view, re-run, cancel, and view logs for workflow runs in {% data variables.product.prodname_actions %}. {% 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)."

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


<!-- Content after this section is automatically generated -->
4 changes: 4 additions & 0 deletions content/rest/actions/workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,14 @@ versions:
ghes: '*'
ghae: '*'
ghec: '*'
autogenerated: true
---

## About workflows in {% data variables.product.prodname_actions %}

You can use the REST API to view workflows for a repository in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-workflows %} For more information, see "[Automating your workflow with GitHub Actions](/actions/automating-your-workflow-with-github-actions)."

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


<!-- Content after this section is automatically generated -->
4 changes: 4 additions & 0 deletions content/rest/activity/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ versions:
topics:
- API
miniTocMaxHeadingLevel: 3
autogenerated: true
---

## About {% data variables.product.prodname_dotcom %} events
Expand All @@ -33,3 +34,6 @@ $ -H 'If-None-Match: "a18c3bded88eb5dbb5c849a489412bf3"'
```

Only events created within the past 90 days will be included in timelines. Events older than 90 days will not be included (even if the total number of events in the timeline is less than 300).


<!-- Content after this section is automatically generated -->
4 changes: 4 additions & 0 deletions content/rest/activity/feeds.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ versions:
topics:
- API
miniTocMaxHeadingLevel: 3
autogenerated: true
---

## About {% data variables.product.prodname_dotcom %} feeds
Expand Down Expand Up @@ -78,3 +79,6 @@ xml:lang="en-US">
</entry>
</feed>
```


<!-- Content after this section is automatically generated -->
4 changes: 4 additions & 0 deletions content/rest/activity/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,9 @@ children:
- /notifications
- /starring
- /watching
autogenerated: true
---



<!-- Content after this section is automatically generated -->
Loading

0 comments on commit 8d3eb29

Please sign in to comment.