EDI-ify "Concepts" and "Get started" in the Actions docs (#56827)
This commit is contained in:
Sam Browning
@@ -1,18 +1,18 @@
|
||||
---
|
||||
title: Concepts for GitHub Actions
|
||||
shortTitle: Concepts
|
||||
intro: "Learn the core concepts that you'll need to understand GitHub Actions."
|
||||
intro: Learn the core concepts that you'll need to understand GitHub Actions.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
children:
|
||||
- /overview
|
||||
- /workflows-and-actions
|
||||
- /runners
|
||||
- /security
|
||||
- /about-github-actions-metrics
|
||||
- /metrics
|
||||
- /billing-and-usage
|
||||
redirect_from:
|
||||
- /actions/concepts/use-cases
|
||||
---
|
||||
|
||||
|
||||
@@ -2,9 +2,11 @@
|
||||
title: About GitHub Actions metrics
|
||||
shortTitle: Metrics
|
||||
intro: 'Learn about the {% data variables.product.prodname_actions %} metrics available for your organizations and repositories.'
|
||||
permissions: Organization owners and users with the "View organization Actions metrics" permission can view organization-level metrics. <br><br> Users with the base repository role can view repository-level metrics.
|
||||
permissions: Organization owners and users with the "View organization Actions metrics" permission can view organization-level metrics. <br><br> Users with the base repository role can view repository-level metrics.
|
||||
versions:
|
||||
feature: actions-metrics
|
||||
redirect_from:
|
||||
- /actions/concepts/about-github-actions-metrics
|
||||
---
|
||||
|
||||
{% data reusables.actions.about-actions-metrics %}
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
title: Overview of GitHub Actions
|
||||
shortTitle: Overview
|
||||
intro: "Learn the overarching concepts that apply to GitHub Actions as a whole."
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
children:
|
||||
- /continuous-integration
|
||||
- /continuous-deployment
|
||||
- /github-actions-vs-github-apps
|
||||
---
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: GitHub Actions Runners
|
||||
shortTitle: Runners
|
||||
intro: "Learn about the concept of runners in GitHub Actions."
|
||||
intro: Learn about the concept of runners in GitHub Actions.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -10,9 +10,10 @@ children:
|
||||
- /github-hosted-runners
|
||||
- /larger-runners
|
||||
- /self-hosted-runners
|
||||
- /private-networking-with-github-hosted-runners
|
||||
- /private-networking
|
||||
- /runner-groups
|
||||
- /runner-scale-sets
|
||||
- /actions-runner-controller
|
||||
- /support-for-actions-runner-controller
|
||||
- /support-for-arc
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Private networking with GitHub-hosted runners
|
||||
shortTitle: About private networking
|
||||
shortTitle: Private networking
|
||||
intro: '{% data reusables.actions.private-networking-intro %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
@@ -17,6 +17,7 @@ topics:
|
||||
redirect_from:
|
||||
- /actions/using-github-hosted-runners/connecting-to-a-private-network/about-private-networking-with-github-hosted-runners
|
||||
- /actions/concepts/runners/about-private-networking-with-github-hosted-runners
|
||||
- /actions/concepts/runners/private-networking-with-github-hosted-runners
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
@@ -12,6 +12,7 @@ topics:
|
||||
redirect_from:
|
||||
- /actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-support-for-actions-runner-controller
|
||||
- /actions/concepts/runners/about-support-for-actions-runner-controller
|
||||
- /actions/concepts/runners/support-for-actions-runner-controller
|
||||
---
|
||||
|
||||
## Overview
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Artifact attestations
|
||||
intro: 'Understand the usage and security benefits of artifact attestations.'
|
||||
shortTitle: Artifact attestations
|
||||
topics:
|
||||
- Actions
|
||||
- Security
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Compromised runners
|
||||
intro: 'Understand the security risks associated with compromised {% data variables.product.prodname_actions %} runners.'
|
||||
shortTitle: Compromised runners
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: GITHUB_TOKEN
|
||||
intro: Learn what `GITHUB_TOKEN` is, how it works, and why it matters for secure automation in {% data variables.product.prodname_actions %} workflows.
|
||||
shortTitle: GITHUB_TOKEN
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: OpenID Connect
|
||||
shortTitle: OpenID Connect
|
||||
intro: OpenID Connect allows your workflows to exchange short-lived tokens directly from your cloud provider.
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Script injections
|
||||
intro: Understand the security risks associated with script injections and {% data variables.product.prodname_actions %} workflows.
|
||||
shortTitle: Script injections
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
|
||||
@@ -1,47 +0,0 @@
|
||||
---
|
||||
title: Avoiding duplication
|
||||
shortTitle: Avoid duplication
|
||||
intro: You can use reusable workflows or composite actions to avoid duplicating the content of workflows.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Workflows
|
||||
redirect_from:
|
||||
- /actions/using-workflows/avoiding-duplication
|
||||
- /actions/sharing-automations/avoiding-duplication
|
||||
---
|
||||
|
||||
## About reusable workflows and composite actions
|
||||
|
||||
Reusable workflows and composite actions are two ways to avoid duplicating the content of workflows.
|
||||
|
||||
**Reusable workflows** allow you to reuse an entire workflow, including all of its jobs and steps. This is particularly useful when you have a complete CI/CD process that you want to use across multiple repositories. Reusable workflows can be centrally maintained, in one location, but used in many repositories across your organization.
|
||||
|
||||
**Composite actions** allow you to combine multiple steps into a single action. You can then run this bundle of steps as a single step within a workflow. This is useful if you have a sequence of steps that will be used in more than one workflow. Composite actions allow you refactor long YAML workflow files into much smaller files and avoid copying and pasting between workflow files.
|
||||
|
||||
Reusable workflows and composite actions solve similar problems, but have a few important differences. Most of the time you can use either solution. But some of the time, you’ll need to use one or the other, as described later in this article.
|
||||
|
||||
For details of how to create and use reusable workflows and composite actions, see [AUTOTITLE](/actions/using-workflows/reusing-workflows) and [AUTOTITLE](/actions/creating-actions/creating-a-composite-action).
|
||||
|
||||
## Comparison of reusable workflows and composite actions
|
||||
|
||||
* **Workflow jobs** - Composite actions contain a series of steps, that are run as a single step within the caller workflow. Unlike reusable workflows, they cannot contain jobs.
|
||||
* **Logging** - When a composite action runs, the log will show just the step in the caller workflow that ran the composite action, not the individual steps within the composite action. With reusable workflows, every job and step is logged separately.
|
||||
* **Specifying runners** - Reusable workflows contain one or more jobs. As with all workflow jobs, the jobs in a reusable workflow specify the type of machine on which the job will run. Therefore, if the steps must be run on a type of machine that might be different from the machine chosen for the calling workflow job, then you should use a reusable workflow, not a composite action.
|
||||
* **Passing output to steps** - A composite action is run as a step within a workflow job, and you can have multiple steps before or after the step that runs the composite action. Reusable workflows are called directly within a job, and not from within a job step. You can't add steps to a job after calling a reusable workflow, so you can't use `GITHUB_ENV` to pass values to subsequent job steps in the caller workflow.
|
||||
|
||||
### Key differences between reusable workflows and composite actions
|
||||
|
||||
| Reusable workflows | Composite actions |
|
||||
| ------------------ | ----------------- |
|
||||
| A YAML file, very similar to any standard workflow file | An action containing a bundle of workflow steps |
|
||||
| Each reusable workflow is a single file in the `.github/workflows` directory of a repository | Each composite action is a separate repository, or a directory, containing an `action.yml` file and, optionally, other files |
|
||||
| Called by referencing a specific YAML file | Called by referencing a repository or directory in which the action is defined |
|
||||
| Called directly within a job, not from a step | Run as a step within a job |
|
||||
| Can contain multiple jobs | Does not contain jobs |
|
||||
| Each step is logged in real-time | Logged as one step even if it contains multiple steps |
|
||||
| Can connect a maximum of four levels of workflows | Can be nested to have up to 10 composite actions in one workflow |
|
||||
| Can use secrets | Cannot use secrets |
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: Contexts
|
||||
shortTitle: Contexts
|
||||
intro: 'Learn about contexts in {% data variables.product.prodname_actions %}.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -10,6 +10,7 @@ redirect_from:
|
||||
- /actions/creating-actions/about-actions
|
||||
- /actions/creating-actions/about-custom-actions
|
||||
- /actions/sharing-automations/creating-actions/about-custom-actions
|
||||
- /actions/concepts/workflows-and-actions/about-custom-actions
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: Dependency caching
|
||||
shortTitle: Dependency caching
|
||||
intro: 'Learn about dependency caching for workflow speed and efficiency.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Workflows and actions
|
||||
intro: "Learn about the concepts of workflows and actions in GitHub Actions."
|
||||
intro: Learn about the concepts of workflows and actions in GitHub Actions.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -8,11 +8,10 @@ versions:
|
||||
children:
|
||||
- /workflows
|
||||
- /variables
|
||||
- /avoiding-duplication
|
||||
- /reusable-workflows
|
||||
- /about-custom-actions
|
||||
- /contexts
|
||||
- /expressions
|
||||
- /reusable-workflows
|
||||
- /custom-actions
|
||||
- /deployment-environments
|
||||
- /concurrency
|
||||
- /workflow-artifacts
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: Notifications for workflow runs
|
||||
shortTitle: Notifications for workflow runs
|
||||
intro: You can subscribe to notifications about workflow runs that you trigger.
|
||||
versions:
|
||||
fpt: '*'
|
||||
@@ -10,7 +9,7 @@ redirect_from:
|
||||
- /actions/monitoring-and-troubleshooting-workflows/notifications-for-workflow-runs
|
||||
- /actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/notifications-for-workflow-runs
|
||||
---
|
||||
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
|
||||
{% data reusables.repositories.workflow-notifications %}
|
||||
|
||||
@@ -1,11 +1,14 @@
|
||||
---
|
||||
title: Reusable workflows
|
||||
shortTitle: Reusable workflows
|
||||
intro: Learn how to avoid duplication when creating a workflow by reusing existing workflows.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '*'
|
||||
redirect_from:
|
||||
- /actions/using-workflows/avoiding-duplication
|
||||
- /actions/sharing-automations/avoiding-duplication
|
||||
- /actions/concepts/workflows-and-actions/avoiding-duplication
|
||||
---
|
||||
|
||||
## About reusable workflows
|
||||
@@ -32,7 +35,27 @@ You can view the reused workflows referenced in your {% data variables.product.p
|
||||
|
||||
## Reusable workflows versus composite actions
|
||||
|
||||
Reusable workflows and composite actions both help you to avoid duplication. Whereas reusable workflows allow you to reuse an entire workflow, with multiple jobs and steps, composite actions combine multiple steps that you can then run within a job step, just like any other action. For more information, see [AUTOTITLE](/actions/using-workflows/avoiding-duplication).
|
||||
Reusable workflows and composite actions both help you avoid duplicating workflow content. Whereas reusable workflows allow you to reuse an entire workflow, with multiple jobs and steps, composite actions combine multiple steps that you can then run within a job step, just like any other action.
|
||||
|
||||
Let's compare some aspects of each solution:
|
||||
|
||||
* **Workflow jobs** - Composite actions contain a series of steps that are run as a single step within the caller workflow. Unlike reusable workflows, they cannot contain jobs.
|
||||
* **Logging** - When a composite action runs, the log will show just the step in the caller workflow that ran the composite action, not the individual steps within the composite action. With reusable workflows, every job and step is logged separately.
|
||||
* **Specifying runners** - Reusable workflows contain one or more jobs. As with all workflow jobs, the jobs in a reusable workflow specify the type of machine on which the job will run. Therefore, if the steps must be run on a type of machine that might be different from the machine chosen for the calling workflow job, then you should use a reusable workflow, not a composite action.
|
||||
* **Passing output to steps** - A composite action is run as a step within a workflow job, and you can have multiple steps before or after the step that runs the composite action. Reusable workflows are called directly within a job, and not from within a job step. You can't add steps to a job after calling a reusable workflow, so you can't use `GITHUB_ENV` to pass values to subsequent job steps in the caller workflow.
|
||||
|
||||
### Key differences between reusable workflows and composite actions
|
||||
|
||||
| Reusable workflows | Composite actions |
|
||||
| ------------------ | ----------------- |
|
||||
| A YAML file, very similar to any standard workflow file | An action containing a bundle of workflow steps |
|
||||
| Each reusable workflow is a single file in the `.github/workflows` directory of a repository | Each composite action is a separate repository, or a directory, containing an `action.yml` file and, optionally, other files |
|
||||
| Called by referencing a specific YAML file | Called by referencing a repository or directory in which the action is defined |
|
||||
| Called directly within a job, not from a step | Run as a step within a job |
|
||||
| Can contain multiple jobs | Does not contain jobs |
|
||||
| Each step is logged in real-time | Logged as one step even if it contains multiple steps |
|
||||
| Can connect a maximum of four levels of workflows | Can be nested to have up to 10 composite actions in one workflow |
|
||||
| Can use secrets | Cannot use secrets |
|
||||
|
||||
## Reusable workflows and workflow templates
|
||||
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: Workflows
|
||||
shortTitle: Workflows
|
||||
intro: 'Get a high-level overview of {% data variables.product.prodname_actions %} workflows, including triggers, syntax, and advanced features.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -9,6 +9,9 @@ versions:
|
||||
type: overview
|
||||
topics:
|
||||
- CD
|
||||
redirect_from:
|
||||
- /actions/concepts/overview/github-actions-vs-github-apps
|
||||
- /actions/get-started/github-actions-vs-github-apps
|
||||
---
|
||||
|
||||
{% data variables.product.prodname_marketplace %} offers both {% data variables.product.prodname_actions %} and {% data variables.product.prodname_github_apps %}, each of which can be valuable automation and workflow tools. Understanding the differences and the benefits of each option will allow you to select the best fit for your job.
|
||||
@@ -13,6 +13,7 @@ redirect_from:
|
||||
- /actions/about-github-actions/about-continuous-deployment
|
||||
- /actions/about-github-actions/about-continuous-deployment-with-github-actions
|
||||
- /actions/concepts/overview/about-continuous-deployment-with-github-actions
|
||||
- /actions/concepts/overview/continuous-deployment
|
||||
topics:
|
||||
- CD
|
||||
---
|
||||
@@ -11,6 +11,7 @@ redirect_from:
|
||||
- /actions/about-github-actions/about-continuous-integration
|
||||
- /actions/about-github-actions/about-continuous-integration-with-github-actions
|
||||
- /actions/concepts/overview/about-continuous-integration-with-github-actions
|
||||
- /actions/concepts/overview/continuous-integration
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -18,7 +19,6 @@ versions:
|
||||
type: overview
|
||||
topics:
|
||||
- CI
|
||||
shortTitle: Continuous integration
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
@@ -1,14 +1,18 @@
|
||||
---
|
||||
title: Get started with GitHub Actions
|
||||
shortTitle: Get started
|
||||
intro: "Learn the basics of GitHub Actions."
|
||||
intro: Learn the basics of GitHub Actions.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
children:
|
||||
- /quickstart
|
||||
- /understanding-github-actions
|
||||
- /understand-github-actions
|
||||
- /continuous-integration
|
||||
- /continuous-deployment
|
||||
- /actions-vs-apps
|
||||
redirect_from:
|
||||
- /actions/about-github-actions
|
||||
- /actions/concepts/overview
|
||||
---
|
||||
|
||||
@@ -11,6 +11,7 @@ redirect_from:
|
||||
- /actions/learn-github-actions/essential-features-of-github-actions
|
||||
- /articles/getting-started-with-github-actions
|
||||
- /actions/about-github-actions/understanding-github-actions
|
||||
- /actions/get-started/understanding-github-actions
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -3,13 +3,13 @@ title: '{% data variables.product.prodname_actions %} documentation'
|
||||
shortTitle: '{% data variables.product.prodname_actions %}'
|
||||
intro: 'Automate, customize, and execute your software development workflows right in your repository with {% data variables.product.prodname_actions %}. You can discover, create, and share actions to perform any job you''d like, including CI/CD, and combine actions in a completely customized workflow.'
|
||||
introLinks:
|
||||
overview: /actions/get-started/understanding-github-actions
|
||||
overview: /actions/get-started/understand-github-actions
|
||||
quickstart: /actions/get-started/quickstart
|
||||
featuredLinks:
|
||||
startHere:
|
||||
- /actions/how-tos/writing-workflows
|
||||
- /actions/tutorials
|
||||
- /actions/concepts/overview/continuous-integration
|
||||
- /actions/get-started/continuous-integration
|
||||
- /packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions
|
||||
guideCards:
|
||||
- /actions/how-tos/writing-workflows/using-workflow-templates
|
||||
|
||||
@@ -44,7 +44,7 @@ adopting_github_actions_for_your_enterprise_ghec:
|
||||
guides:
|
||||
- >-
|
||||
/admin/managing-github-actions-for-your-enterprise/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises
|
||||
- /actions/get-started/understanding-github-actions
|
||||
- /actions/get-started/understand-github-actions
|
||||
- >-
|
||||
/admin/managing-github-actions-for-your-enterprise/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise
|
||||
- >-
|
||||
@@ -65,7 +65,7 @@ adopting_github_actions_for_your_enterprise_ghes:
|
||||
guides:
|
||||
- >-
|
||||
/admin/managing-github-actions-for-your-enterprise/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises
|
||||
- /actions/get-started/understanding-github-actions
|
||||
- /actions/get-started/understand-github-actions
|
||||
- >-
|
||||
/admin/managing-github-actions-for-your-enterprise/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise
|
||||
- >-
|
||||
|
||||
Reference in New Issue
Block a user