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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
10 changes: 5 additions & 5 deletions content/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ See the [contributing docs](https://docs.github.com/en/contributing) for general
- [`learningTracks`](#learningtracks)
- [`includeGuides`](#includeguides)
- [`journeyTracks`](#journeytracks)
- [`type`](#type)
- [`contentType`](#contenttype)
- [`communityRedirect`](#communityRedirect)
- [`effectiveDate`](#effectiveDate)
- [Escaping single quotes](#escaping-single-quotes)
Expand Down Expand Up @@ -238,7 +238,7 @@ defaultTool: cli
**Note: the featured track is set by a specific property in the learning tracks YAML. See that [README](../data/learning-tracks/README.md) for details.*

### `includeGuides`
- Purpose: Render a list of articles, filterable by `type` and `topics`. Only applicable when used with `layout: product-guides`.
- Purpose: Render a list of articles, filterable by `contentType` and `topics`. Only applicable when used with `layout: product-guides`.
- Type: `Array`
- Optional.

Expand Down Expand Up @@ -284,9 +284,9 @@ journeyTracks:
- href: '/actions/deployment/deploying-with-github-actions'
```

### `type`
### `contentType`
- Purpose: Indicate the type of article.
- Type: `String`, one of the `overview`, `quick_start`, `tutorial`, `how_to`, `reference`.
- Type: `String`, one of `get-started`, `concepts`, `how-tos`, `reference`, `tutorials`, `rai`, `landing` (only applies to `content/<product>/index.md` files).
- Optional.

### `communityRedirect`
Expand Down Expand Up @@ -442,4 +442,4 @@ To create a product guides page (e.g. [Actions' Guide page](https://docs.github.
1. (optional) Define which articles to include with [`includeGuides`](#includeGuides).

If using learning tracks, they need to be defined in [`data/learning-tracks/*.yml`](../data/learning-tracks/README.md).
If using `includeGuides`, make sure each of the articles in this list has [`type`](#type) in its frontmatter.
If using `includeGuides`, make sure each of the articles in this list has [`contentType`](#contenttype) in its frontmatter.
2 changes: 2 additions & 0 deletions content/actions/concepts/billing-and-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
category:
- Administer GitHub Actions
---

## About billing for {% data variables.product.prodname_actions %}
Expand Down
2 changes: 2 additions & 0 deletions content/actions/concepts/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ versions:
feature: actions-metrics
redirect_from:
- /actions/concepts/about-github-actions-metrics
category:
- Administer GitHub Actions
---

{% data reusables.actions.about-actions-metrics %}
Expand Down
2 changes: 2 additions & 0 deletions content/actions/concepts/runners/actions-runner-controller.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ versions:
redirect_from:
- /actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-actions-runner-controller
- /actions/concepts/runners/about-actions-runner-controller
category:
- Set up runners
---

## About {% data variables.product.prodname_actions_runner_controller %}
Expand Down
2 changes: 2 additions & 0 deletions content/actions/concepts/runners/github-hosted-runners.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
category:
- Set up runners
---

{% data reusables.actions.enterprise-github-hosted-runners %}
Expand Down
2 changes: 2 additions & 0 deletions content/actions/concepts/runners/larger-runners.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ redirect_from:
- /actions/using-github-hosted-runners/about-larger-runners/about-larger-runners
- /actions/using-github-hosted-runners/using-larger-runners/about-larger-runners
- /actions/concepts/runners/about-larger-runners
category:
- Set up runners
---

{% ifversion ghes %}
Expand Down
2 changes: 2 additions & 0 deletions content/actions/concepts/runners/private-networking.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ 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
category:
- Set up runners
---

{% data reusables.actions.enterprise-github-hosted-runners %}
Expand Down
2 changes: 2 additions & 0 deletions content/actions/concepts/runners/runner-groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ versions:
ghes: '*'
redirect_from:
- /actions/concepts/runners/about-runner-groups
category:
- Set up runners
---

## About runner groups
Expand Down
2 changes: 2 additions & 0 deletions content/actions/concepts/runners/runner-scale-sets.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ versions:
ghes: '*'
redirect_from:
- /actions/concepts/runners/about-runner-scale-sets
category:
- Set up runners
---

## About runner scale sets
Expand Down
2 changes: 2 additions & 0 deletions content/actions/concepts/runners/self-hosted-runners.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ versions:
ghes: '*'
ghec: '*'
contentType: concepts
category:
- Set up runners
---

A self-hosted runner is a system that you deploy and manage to execute jobs from {% data variables.product.prodname_actions %} on {% data variables.product.github %}.
Expand Down
2 changes: 2 additions & 0 deletions content/actions/concepts/runners/support-for-arc.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ 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
category:
- Set up runners
---

## Overview
Expand Down
2 changes: 2 additions & 0 deletions content/actions/concepts/security/artifact-attestations.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ intro: 'Understand the usage and security benefits of artifact attestations.'
versions:
fpt: '*'
ghec: '*'
category:
- Secure your workflows
---

## Overview
Expand Down
2 changes: 2 additions & 0 deletions content/actions/concepts/security/compromised-runners.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ versions:
ghec: '*'
redirect_from:
- /actions/concepts/security/compromised-runner
category:
- Secure your workflows
---

## Potential impact of a compromised runner
Expand Down
2 changes: 2 additions & 0 deletions content/actions/concepts/security/github_token.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
category:
- Secure your workflows
---

## About the `GITHUB_TOKEN`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ intro: Understand how you can use an admissions controller to enforce artifact a
versions:
fpt: '*'
ghec: '*'
category:
- Secure your workflows
---

## About Kubernetes admission controller
Expand Down
4 changes: 3 additions & 1 deletion content/actions/concepts/security/openid-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ versions:
fpt: '*'
ghec: '*'
ghes: '*'
type: tutorial
redirect_from:
- /actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect
- /actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-openid-connect
- /actions/concepts/security/about-security-hardening-with-openid-connect
contentType: tutorials
category:
- Secure your workflows
---

## Overview of OpenID Connect (OIDC)
Expand Down
2 changes: 2 additions & 0 deletions content/actions/concepts/security/script-injections.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
category:
- Secure your workflows
---

## Understanding the risk of script injections
Expand Down
2 changes: 2 additions & 0 deletions content/actions/concepts/security/secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ versions:
redirect_from:
- /actions/security-for-github-actions/security-guides/about-secrets
- /actions/concepts/security/about-secrets
category:
- Secure your workflows
---

## About secrets
Expand Down
6 changes: 4 additions & 2 deletions content/actions/concepts/workflows-and-actions/concurrency.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
---
title: Concurrency
intro: 'Learn about running workflows and jobs simultaneously.'
intro: Learn about running workflows and jobs simultaneously.
versions:
fpt: '*'
ghes: '*'
ghec: '*'
type: overview
contentType: concepts
category:
- Write workflows
---

By default, {% data variables.product.prodname_actions %} allows multiple jobs within the same workflow, multiple workflow runs within the same repository, and multiple workflow runs across a repository owner's account to run concurrently. This means that multiple instances of the same workflow or job can run at the same time, performing the same steps.
Expand Down
6 changes: 4 additions & 2 deletions content/actions/concepts/workflows-and-actions/contexts.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
---
title: Contexts
intro: 'Learn about contexts in {% data variables.product.prodname_actions %}.'
intro: Learn about contexts in {% data variables.product.prodname_actions %}.
versions:
fpt: '*'
ghes: '*'
ghec: '*'
type: overview
contentType: concepts
category:
- Write workflows
---

## About contexts
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: About custom actions
shortTitle: Custom actions
intro: 'Actions are individual tasks that you can combine to create jobs and customize your workflow. You can create your own actions, or use and customize actions shared by the {% data variables.product.prodname_dotcom %} community.'
intro: Actions are individual tasks that you can combine to create jobs and customize your workflow. You can create your own actions, or use and customize actions shared by the {% data variables.product.prodname_dotcom %} community.
redirect_from:
- /articles/about-actions
- /github/automating-your-workflow-with-github-actions/about-actions
Expand All @@ -15,7 +15,9 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
type: overview
contentType: concepts
category:
- Reuse and share automations
---

{% data reusables.actions.enterprise-github-hosted-runners %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
---
title: Dependency caching
intro: 'Learn about dependency caching for workflow speed and efficiency.'
intro: Learn about dependency caching for workflow speed and efficiency.
versions:
fpt: '*'
ghes: '*'
ghec: '*'
type: overview
contentType: concepts
category:
- Write workflows
---

## About workflow dependency caching
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
---
title: Deployment environments
intro: 'You can create and deploy to different environments.'
intro: You can create and deploy to different environments.
versions:
fpt: '*'
ghes: '*'
ghec: '*'
type: overview
contentType: concepts
category:
- Deploy to environments
---

{% data reusables.actions.about-environments %}
Expand Down
6 changes: 4 additions & 2 deletions content/actions/concepts/workflows-and-actions/expressions.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
---
title: Expressions
intro: 'You can evaluate expressions in workflows and actions.'
intro: You can evaluate expressions in workflows and actions.
versions:
fpt: '*'
ghes: '*'
ghec: '*'
type: overview
contentType: concepts
category:
- Write workflows
---

## About expressions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ versions:
redirect_from:
- /actions/monitoring-and-troubleshooting-workflows/notifications-for-workflow-runs
- /actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/notifications-for-workflow-runs
category:
- Write workflows
---

If you enable email or web notifications for {% data variables.product.prodname_actions %}, you'll receive a notification when any workflow runs that you've triggered have completed. The notification will include the workflow run's status (including successful, failed, neutral, and canceled runs). You can also choose to receive a notification only when a workflow run has failed. For more information about enabling or disabling notifications, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ redirect_from:
- /actions/sharing-automations/avoiding-duplication
- /actions/concepts/workflows-and-actions/avoiding-duplication
- /actions/concepts/workflows-and-actions/reusable-workflows
category:
- Reuse and share automations
---

## Reusable workflows
Expand Down
6 changes: 4 additions & 2 deletions content/actions/concepts/workflows-and-actions/variables.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
---
title: Variables
intro: 'Learn about variables in {% data variables.product.prodname_actions %} workflows.'
intro: Learn about variables in {% data variables.product.prodname_actions %} workflows.
versions:
fpt: '*'
ghes: '*'
ghec: '*'
type: overview
contentType: concepts
category:
- Write workflows
---

## About
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
---
title: Workflow artifacts
intro: 'Learn about storing and sharing data as artifacts of {% data variables.product.prodname_actions %} workflows.'
intro: Learn about storing and sharing data as artifacts of {% data variables.product.prodname_actions %} workflows.
versions:
fpt: '*'
ghes: '*'
ghec: '*'
type: overview
contentType: concepts
category:
- Write workflows
---

## About workflow artifacts
Expand Down
6 changes: 4 additions & 2 deletions content/actions/concepts/workflows-and-actions/workflows.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
title: Workflows
intro: 'Get a high-level overview of {% data variables.product.prodname_actions %} workflows, including triggers, syntax, and advanced features.'
intro: Get a high-level overview of {% data variables.product.prodname_actions %} workflows, including triggers, syntax, and advanced features.
versions:
fpt: '*'
ghes: '*'
ghec: '*'
type: overview
redirect_from:
- /articles/configuring-workflows
- /actions/learn-github-actions/managing-complex-workflows
Expand All @@ -15,6 +14,9 @@ redirect_from:
- /actions/concepts/use-cases/using-github-actions-for-project-management
- /actions/concepts/workflows-and-actions/about-workflows
layout: inline
contentType: concepts
category:
- Write workflows
---

## About workflows
Expand Down
6 changes: 4 additions & 2 deletions content/actions/get-started/actions-vs-apps.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
---
title: GitHub Actions vs GitHub Apps
shortTitle: Actions vs Apps
intro: 'Learn about the key differences between {% data variables.product.prodname_actions %} and {% data variables.product.prodname_github_apps %} to help you decide which is right for your use cases.'
intro: Learn about the key differences between {% data variables.product.prodname_actions %} and {% data variables.product.prodname_github_apps %} to help you decide which is right for your use cases.
versions:
fpt: '*'
ghes: '*'
ghec: '*'
type: overview
redirect_from:
- /actions/concepts/overview/github-actions-vs-github-apps
- /actions/get-started/github-actions-vs-github-apps
contentType: concepts
category:
- Get started with GitHub Actions
---

{% 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
Loading
Loading