Skip to content

Commit 75b8220

Browse files
authored
[EDI] Metadata syntax for GitHub Actions (#56487)
1 parent a9d1bb3 commit 75b8220

File tree

4 files changed

+8
-10
lines changed

4 files changed

+8
-10
lines changed

content/actions/concepts/workflows-and-actions/about-custom-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Actions can run directly on a machine or in a Docker container. You can define a
3333

3434
## Types of actions
3535

36-
You can build Docker container, JavaScript, and composite actions. Actions require a metadata file to define the inputs, outputs and main entrypoint for your action. The metadata filename must be `action.yml`. For more information, see [AUTOTITLE](/actions/creating-actions/metadata-syntax-for-github-actions).
36+
{% data reusables.actions.types-of-actions %}
3737

3838
{% rowheaders %}
3939

content/actions/reference/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ children:
1313
- /variables-reference
1414
- /evaluate-expressions-in-workflows-and-actions
1515
- /contexts-reference
16-
- /metadata-syntax-for-github-actions
16+
- /metadata-syntax-reference
1717
- /actions-limits
1818
- /dockerfile-support-for-github-actions
1919
- /supported-architectures-and-operating-systems-for-self-hosted-runners

content/actions/reference/metadata-syntax-for-github-actions.md renamed to content/actions/reference/metadata-syntax-reference.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Metadata syntax for GitHub Actions
2+
title: Metadata syntax reference
33
shortTitle: Metadata syntax
44
intro: You can create actions to perform tasks in your repository. Actions require a metadata file that uses YAML syntax.
55
redirect_from:
@@ -9,20 +9,16 @@ redirect_from:
99
- /actions/building-actions/metadata-syntax-for-github-actions
1010
- /actions/creating-actions/metadata-syntax-for-github-actions
1111
- /actions/sharing-automations/creating-actions/metadata-syntax-for-github-actions
12+
- /actions/reference/metadata-syntax-for-github-actions
1213
versions:
1314
fpt: '*'
1415
ghes: '*'
1516
ghec: '*'
1617
type: reference
18+
allowTitleToDifferFromFilename: true
1719
---
1820

19-
{% data reusables.actions.enterprise-github-hosted-runners %}
20-
21-
## About YAML syntax for {% data variables.product.prodname_actions %}
22-
23-
All actions require a metadata file. The metadata filename must be either `action.yml` or `action.yaml`. The preferred format is `action.yml`. The data in the metadata file defines the inputs, outputs, and runs configuration for your action.
24-
25-
Action metadata files use YAML syntax. If you're new to YAML, you can read [Learn YAML in five minutes](https://www.codeproject.com/Articles/1214409/Learn-YAML-in-five-minutes).
21+
{% data reusables.actions.types-of-actions %}
2622

2723
## `name`
2824

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
>[!NOTE]
2+
> You can build Docker container, JavaScript, and composite actions. Actions require a metadata file to define the inputs, outputs, and runs configuration for your action. Action metadata files use YAML syntax, and the metadata filename must be either `action.yml` or `action.yaml`. The preferred format is `action.yml`.

0 commit comments

Comments
 (0)