Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions content/actions/concepts/index.md
Original file line number Diff line number Diff line change
@@ -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
---

Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
Expand Down
13 changes: 0 additions & 13 deletions content/actions/concepts/overview/index.md

This file was deleted.

7 changes: 4 additions & 3 deletions content/actions/concepts/runners/index.md
Original file line number Diff line number Diff line change
@@ -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: '*'
Expand All @@ -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
---

Original file line number Diff line number Diff line change
@@ -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: '*'
Expand All @@ -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 %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion content/actions/concepts/security/artifact-attestations.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Artifact attestations
intro: 'Understand the usage and security benefits of artifact attestations.'
shortTitle: Artifact attestations
topics:
- Actions
- Security
Expand Down
1 change: 0 additions & 1 deletion content/actions/concepts/security/compromised-runners.md
Original file line number Diff line number Diff line change
@@ -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: '*'
Expand Down
1 change: 0 additions & 1 deletion content/actions/concepts/security/github_token.md
Original file line number Diff line number Diff line change
@@ -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: '*'
Expand Down
1 change: 0 additions & 1 deletion content/actions/concepts/security/openid-connect.md
Original file line number Diff line number Diff line change
@@ -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: '*'
Expand Down
1 change: 0 additions & 1 deletion content/actions/concepts/security/script-injections.md
Original file line number Diff line number Diff line change
@@ -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: '*'
Expand Down

This file was deleted.

1 change: 0 additions & 1 deletion content/actions/concepts/workflows-and-actions/contexts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Contexts
shortTitle: Contexts
intro: 'Learn about contexts in {% data variables.product.prodname_actions %}.'
versions:
fpt: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Dependency caching
shortTitle: Dependency caching
intro: 'Learn about dependency caching for workflow speed and efficiency.'
versions:
fpt: '*'
Expand Down
7 changes: 3 additions & 4 deletions content/actions/concepts/workflows-and-actions/index.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
---
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: '*'
ghec: '*'
children:
- /workflows
- /variables
- /avoiding-duplication
- /reusable-workflows
- /about-custom-actions
- /contexts
- /expressions
- /reusable-workflows
- /custom-actions
- /deployment-environments
- /concurrency
- /workflow-artifacts
Expand Down
Original file line number Diff line number Diff line change
@@ -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: '*'
Expand All @@ -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 %}
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ 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: '*'
ghec: '*'
type: overview
topics:
- CI
shortTitle: Continuous integration
---

{% data reusables.actions.enterprise-github-hosted-runners %}
Expand Down
8 changes: 6 additions & 2 deletions content/actions/get-started/index.md
Original file line number Diff line number Diff line change
@@ -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
---
Original file line number Diff line number Diff line change
Expand Up @@ -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: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ redirect_from:
- /actions/managing-workflow-runs/using-workflow-run-logs
- /actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs
- /actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/using-workflow-run-logs
- /actions/how-tos/monitoring-and-troubleshooting-workflows/monitoring-workflows/using-workflow-run-logs
versions:
fpt: '*'
ghes: '*'
Expand Down
4 changes: 2 additions & 2 deletions content/actions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading
Loading