Skip to content

Commit cb12455

Browse files
committed
ran script/content-migrations/use-short-versions.js
1 parent 7de66fe commit cb12455

File tree

1,976 files changed

+6155
-6133
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,976 files changed

+6155
-6133
lines changed

content/actions/creating-actions/about-actions.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ redirect_from:
88
- /actions/automating-your-workflow-with-github-actions/about-actions
99
- /actions/building-actions/about-actions
1010
versions:
11-
free-pro-team: '*'
12-
enterprise-server: '>=2.22'
13-
github-ae: '*'
11+
fpt: '*'
12+
ghes: '>=2.22'
13+
ghae: '*'
1414
type: overview
1515
topics:
1616
- Action development
@@ -25,7 +25,7 @@ topics:
2525

2626
You can create actions by writing custom code that interacts with your repository in any way you'd like, including integrating with {% data variables.product.prodname_dotcom %}'s APIs and any publicly available third-party API. For example, an action can publish npm modules, send SMS alerts when urgent issues are created, or deploy production-ready code.
2727

28-
{% if currentVersion == "free-pro-team@latest" %}
28+
{% ifversion fpt %}
2929
You can write your own actions to use in your workflow or share the actions you build with the {% data variables.product.prodname_dotcom %} community. To share actions you've built, your repository must be public.
3030
{% endif %}
3131

@@ -65,11 +65,11 @@ A _composite run steps_ action allows you to combine multiple workflow run steps
6565

6666
If you're developing an action for other people to use, we recommend keeping the action in its own repository instead of bundling it with other application code. This allows you to version, track, and release the action just like any other software.
6767

68-
{% if currentVersion == "free-pro-team@latest" %}
68+
{% ifversion fpt %}
6969
Storing an action in its own repository makes it easier for the {% data variables.product.prodname_dotcom %} community to discover the action, narrows the scope of the code base for developers fixing issues and extending the action, and decouples the action's versioning from the versioning of other application code.
7070
{% endif %}
7171

72-
{% if currentVersion == "free-pro-team@latest" %}If you're building an action that you don't plan to make available to the public, you {% else %} You{% endif %} can store the action's files in any location in your repository. If you plan to combine action, workflow, and application code in a single repository, we recommend storing actions in the `.github` directory. For example, `.github/actions/action-a` and `.github/actions/action-b`.
72+
{% ifversion fpt %}If you're building an action that you don't plan to make available to the public, you {% else %} You{% endif %} can store the action's files in any location in your repository. If you plan to combine action, workflow, and application code in a single repository, we recommend storing actions in the `.github` directory. For example, `.github/actions/action-a` and `.github/actions/action-b`.
7373

7474
## Compatibility with {% data variables.product.prodname_ghe_server %}
7575

@@ -127,7 +127,7 @@ steps:
127127
128128
### Using a commit's SHA for release management
129129
130-
Each Git commit receives a calculated SHA value, which is unique and immutable. Your action's users might prefer to rely on a commit's SHA value, as this approach can be more reliable than specifying a tag, which could be deleted or moved. However, this means that users will not receive further updates made to the action. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}You must use a commit's full SHA value, and not an abbreviated value.{% else %}Using a commit's full SHA value instead of the abbreviated value can help prevent people from using a malicious commit that uses the same abbreviation.{% endif %}
130+
Each Git commit receives a calculated SHA value, which is unique and immutable. Your action's users might prefer to rely on a commit's SHA value, as this approach can be more reliable than specifying a tag, which could be deleted or moved. However, this means that users will not receive further updates made to the action. {% ifversion fpt or ghes > 3.0 or ghae %}You must use a commit's full SHA value, and not an abbreviated value.{% else %}Using a commit's full SHA value instead of the abbreviated value can help prevent people from using a malicious commit that uses the same abbreviation.{% endif %}
131131
132132
```yaml
133133
steps:

content/actions/creating-actions/creating-a-composite-run-steps-action.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ title: Creating a composite run steps action
33
intro: 'In this guide, you''ll learn how to build a composite run steps action.'
44
product: '{% data reusables.gated-features.actions %}'
55
versions:
6-
free-pro-team: '*'
7-
enterprise-server: '>=2.22'
8-
github-ae: '*'
6+
fpt: '*'
7+
ghes: '>=2.22'
8+
ghae: '*'
99
type: tutorial
1010
topics:
1111
- Action development

content/actions/creating-actions/creating-a-docker-container-action.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ redirect_from:
88
- /actions/automating-your-workflow-with-github-actions/creating-a-docker-container-action
99
- /actions/building-actions/creating-a-docker-container-action
1010
versions:
11-
free-pro-team: '*'
12-
enterprise-server: '>=2.22'
13-
github-ae: '*'
11+
fpt: '*'
12+
ghes: '>=2.22'
13+
ghae: '*'
1414
type: tutorial
1515
topics:
1616
- Action development
@@ -36,7 +36,7 @@ Once you complete this project, you should understand how to build your own Dock
3636
You may find it helpful to have a basic understanding of {% data variables.product.prodname_actions %} environment variables and the Docker container filesystem:
3737

3838
- "[Using environment variables](/actions/automating-your-workflow-with-github-actions/using-environment-variables)"
39-
{% if currentVersion == "github-ae@latest" %}
39+
{% ifversion ghae %}
4040
- "[Docker container filesystem](/actions/using-github-hosted-runners/about-ae-hosted-runners#docker-container-filesystem)."
4141
{% else %}
4242
- "[Virtual environments for {% data variables.product.prodname_dotcom %}](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners#docker-container-filesystem)"
@@ -185,7 +185,7 @@ Now you're ready to test your action out in a workflow. When an action is in a p
185185

186186
### Example using a public action
187187

188-
The following workflow code uses the completed _hello world_ action in the public [`actions/hello-world-docker-action`](https://github.com/actions/hello-world-docker-action) repository. Copy the following workflow example code into a `.github/workflows/main.yml` file, but replace the `actions/hello-world-docker-action` with your repository and action name. You can also replace the `who-to-greet` input with your name. {% if currentVersion == "free-pro-team@latest" %}Public actions can be used even if they're not published to {% data variables.product.prodname_marketplace %}. For more information, see "[Publishing an action](/actions/creating-actions/publishing-actions-in-github-marketplace#publishing-an-action)." {% endif %}
188+
The following workflow code uses the completed _hello world_ action in the public [`actions/hello-world-docker-action`](https://github.com/actions/hello-world-docker-action) repository. Copy the following workflow example code into a `.github/workflows/main.yml` file, but replace the `actions/hello-world-docker-action` with your repository and action name. You can also replace the `who-to-greet` input with your name. {% ifversion fpt %}Public actions can be used even if they're not published to {% data variables.product.prodname_marketplace %}. For more information, see "[Publishing an action](/actions/creating-actions/publishing-actions-in-github-marketplace#publishing-an-action)." {% endif %}
189189

190190
{% raw %}
191191
**.github/workflows/main.yml**
@@ -210,7 +210,7 @@ jobs:
210210

211211
### Example using a private action
212212

213-
Copy the following example workflow code into a `.github/workflows/main.yml` file in your action's repository. You can also replace the `who-to-greet` input with your name. {% if currentVersion == "free-pro-team@latest" %}This private action can't be published to {% data variables.product.prodname_marketplace %}, and can only be used in this repository.{% endif %}
213+
Copy the following example workflow code into a `.github/workflows/main.yml` file in your action's repository. You can also replace the `who-to-greet` input with your name. {% ifversion fpt %}This private action can't be published to {% data variables.product.prodname_marketplace %}, and can only be used in this repository.{% endif %}
214214

215215
{% raw %}
216216
**.github/workflows/main.yml**
@@ -237,9 +237,9 @@ jobs:
237237
```
238238
{% endraw %}
239239

240-
From your repository, click the **Actions** tab, and select the latest workflow run. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log.
240+
From your repository, click the **Actions** tab, and select the latest workflow run. {% ifversion fpt or ghes > 3.0 or ghae %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log.
241241

242-
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}
242+
{% ifversion fpt or ghes > 3.0 or ghae %}
243243
![A screenshot of using your action in a workflow](/assets/images/help/repository/docker-action-workflow-run-updated.png)
244244
{% else %}
245245
![A screenshot of using your action in a workflow](/assets/images/help/repository/docker-action-workflow-run.png)

content/actions/creating-actions/creating-a-javascript-action.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ redirect_from:
88
- /actions/automating-your-workflow-with-github-actions/creating-a-javascript-action
99
- /actions/building-actions/creating-a-javascript-action
1010
versions:
11-
free-pro-team: '*'
12-
enterprise-server: '>=2.22'
13-
github-ae: '*'
11+
fpt: '*'
12+
ghes: '>=2.22'
13+
ghae: '*'
1414
type: tutorial
1515
topics:
1616
- Action development
@@ -270,11 +270,11 @@ jobs:
270270
```
271271
{% endraw %}
272272
273-
From your repository, click the **Actions** tab, and select the latest workflow run. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log.
273+
From your repository, click the **Actions** tab, and select the latest workflow run. {% ifversion fpt or ghes > 3.0 or ghae %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log.
274274

275-
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}
275+
{% ifversion fpt or ghes > 3.0 or ghae %}
276276
![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run-updated-2.png)
277-
{% elsif currentVersion ver_gt "enterprise-server@2.22" %}
277+
{% elsif ghes > 2.22 %}
278278
![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run-updated.png)
279279
{% else %}
280280
![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run.png)

content/actions/creating-actions/dockerfile-support-for-github-actions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ product: '{% data reusables.gated-features.actions %}'
66
redirect_from:
77
- /actions/building-actions/dockerfile-support-for-github-actions
88
versions:
9-
free-pro-team: '*'
10-
enterprise-server: '>=2.22'
11-
github-ae: '*'
12-
type: 'reference'
9+
fpt: '*'
10+
ghes: '>=2.22'
11+
ghae: '*'
12+
type: reference
1313
---
1414

1515
{% data reusables.actions.enterprise-beta %}

content/actions/creating-actions/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ redirect_from:
88
- /actions/building-actions
99
- /articles/creating-a-github-action/
1010
versions:
11-
free-pro-team: '*'
12-
enterprise-server: '>=2.22'
13-
github-ae: '*'
11+
fpt: '*'
12+
ghes: '>=2.22'
13+
ghae: '*'
1414
children:
1515
- /about-actions
1616
- /creating-a-docker-container-action

content/actions/creating-actions/metadata-syntax-for-github-actions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ redirect_from:
99
- /actions/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions
1010
- /actions/building-actions/metadata-syntax-for-github-actions
1111
versions:
12-
free-pro-team: '*'
13-
enterprise-server: '>=2.22'
14-
github-ae: '*'
15-
type: 'reference'
12+
fpt: '*'
13+
ghes: '>=2.22'
14+
ghae: '*'
15+
type: reference
1616
---
1717

1818
{% data reusables.actions.enterprise-beta %}
@@ -253,7 +253,7 @@ For more information, see "[`github context`](/actions/reference/context-and-exp
253253

254254
#### `runs.steps[*].env`
255255

256-
**Optional** Sets a `map` of environment variables for only that step. If you want to modify the environment variable stored in the workflow, use {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}`echo "{name}={value}" >> $GITHUB_ENV`{% else %}`echo "::set-env name={name}::{value}"`{% endif %} in a composite run step.
256+
**Optional** Sets a `map` of environment variables for only that step. If you want to modify the environment variable stored in the workflow, use {% ifversion fpt or ghes > 2.22 or ghae %}`echo "{name}={value}" >> $GITHUB_ENV`{% else %}`echo "::set-env name={name}::{value}"`{% endif %} in a composite run step.
257257

258258
#### `runs.steps[*].working-directory`
259259

content/actions/creating-actions/publishing-actions-in-github-marketplace.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ redirect_from:
77
- /actions/automating-your-workflow-with-github-actions/publishing-actions-in-github-marketplace
88
- /actions/building-actions/publishing-actions-in-github-marketplace
99
versions:
10-
free-pro-team: '*'
11-
type: 'how_to'
10+
fpt: '*'
11+
type: how_to
1212
---
1313

1414
{% data reusables.actions.ae-beta %}

content/actions/creating-actions/setting-exit-codes-for-actions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ product: '{% data reusables.gated-features.actions %}'
66
redirect_from:
77
- /actions/building-actions/setting-exit-codes-for-actions
88
versions:
9-
free-pro-team: '*'
10-
enterprise-server: '>=2.22'
11-
github-ae: '*'
12-
type: 'how_to'
9+
fpt: '*'
10+
ghes: '>=2.22'
11+
ghae: '*'
12+
type: how_to
1313
---
1414

1515
{% data reusables.actions.enterprise-beta %}

content/actions/guides/about-continuous-integration.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ redirect_from:
88
- /actions/automating-your-workflow-with-github-actions/about-continuous-integration
99
- /actions/building-and-testing-code-with-continuous-integration/about-continuous-integration
1010
versions:
11-
free-pro-team: '*'
12-
enterprise-server: '>=2.22'
13-
github-ae: '*'
11+
fpt: '*'
12+
ghes: '>=2.22'
13+
ghae: '*'
1414
type: overview
1515
topics:
1616
- CI
@@ -31,7 +31,7 @@ Building and testing your code requires a server. You can build and test updates
3131

3232
## About continuous integration using {% data variables.product.prodname_actions %}
3333

34-
{% if currentVersion == "github-ae@latest" %}CI using {% data variables.product.prodname_actions %} offers workflows that can build the code in your repository and run your tests. Workflows can run on virtual machines hosted by {% data variables.product.prodname_dotcom %}. For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)."
34+
{% ifversion ghae %}CI using {% data variables.product.prodname_actions %} offers workflows that can build the code in your repository and run your tests. Workflows can run on virtual machines hosted by {% data variables.product.prodname_dotcom %}. For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)."
3535
{% else %} CI using {% data variables.product.prodname_actions %} offers workflows that can build the code in your repository and run your tests. Workflows can run on {% data variables.product.prodname_dotcom %}-hosted virtual machines, or on machines that you host yourself. For more information, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)" and "[About self-hosted runners](/actions/automating-your-workflow-with-github-actions/about-self-hosted-runners)."
3636
{% endif %}
3737

@@ -52,9 +52,9 @@ For a definition of common terms, see "[Core concepts for {% data variables.prod
5252

5353
{% data variables.product.product_name %} offers CI workflow templates for a variety of languages and frameworks.
5454

55-
Browse the complete list of CI workflow templates offered by {% data variables.product.product_name %} in the {% if currentVersion == "free-pro-team@latest" %}[actions/starter-workflows](https://github.com/actions/starter-workflows/tree/main/ci) repository{% else %} `actions/starter-workflows` repository on {% data variables.product.product_location %}{% endif %}.
55+
Browse the complete list of CI workflow templates offered by {% data variables.product.product_name %} in the {% ifversion fpt %}[actions/starter-workflows](https://github.com/actions/starter-workflows/tree/main/ci) repository{% else %} `actions/starter-workflows` repository on {% data variables.product.product_location %}{% endif %}.
5656

57-
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@next" %}
57+
{% ifversion fpt or ghes > 3.0 or ghae-next %}
5858
## Skipping workflow runs
5959

6060
If you want to temporarily prevent a workflow from being triggered, you can add a skip instruction to the commit message. Workflows that would otherwise be triggered `on: push` or `on: pull_request`, won't be triggered if you add any of the following strings to the commit message in a push, or the HEAD commit of a pull request:
@@ -89,6 +89,6 @@ For more information, see "[Configuring a workflow](/articles/configuring-a-work
8989
## Further reading
9090

9191
- "[Setting up continuous integration using {% data variables.product.prodname_actions %}](/articles/setting-up-continuous-integration-using-github-actions)"
92-
{% if currentVersion == "free-pro-team@latest" %}
92+
{% ifversion fpt %}
9393
- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)"
9494
{% endif %}

0 commit comments

Comments
 (0)