Skip to content

Commit 5db6916

Browse files
authored
Update the Actions Quickstart article (#51906)
1 parent ab8e9b4 commit 5db6916

File tree

56 files changed

+213
-178
lines changed

Some content is hidden

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

56 files changed

+213
-178
lines changed

content/actions/about-github-actions/about-continuous-deployment-with-github-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ You can configure your CD workflow to run when a {% data variables.product.produ
3636

3737
{% data reusables.actions.about-oidc-short-overview %}
3838

39-
## Starter workflows and third party actions
39+
## Workflow templates and third party actions
4040

4141
{% data reusables.actions.cd-templates-actions %}
4242

content/actions/about-github-actions/about-continuous-integration-with-github-actions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,17 @@ You can configure your CI workflow to run when a {% data variables.product.prodn
3737

3838
{% data variables.product.product_name %} runs your CI tests and provides the results of each test in the pull request, so you can see whether the change in your branch introduces an error. When all CI tests in a workflow pass, the changes you pushed are ready to be reviewed by a team member or merged. When a test fails, one of your changes may have caused the failure.
3939

40-
When you set up CI in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends CI workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a starter workflow that installs your Node.js packages and runs your tests. You can use the CI starter workflow suggested by {% data variables.product.product_name %}, customize the suggested starter workflow, or create your own custom workflow file to run your CI tests.
40+
When you set up CI in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends CI workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a workflow template that installs your Node.js packages and runs your tests. You can use the CI workflow template suggested by {% data variables.product.product_name %}, customize the suggested workflow template, or create your own custom workflow file to run your CI tests.
4141

4242
In addition to helping you set up CI workflows for your project, you can use {% data variables.product.prodname_actions %} to create workflows across the full software development life cycle. For example, you can use actions to deploy, package, or release your project. For more information, see "[AUTOTITLE](/actions/learn-github-actions)."
4343

4444
For a definition of common terms, see "[AUTOTITLE](/actions/learn-github-actions/understanding-github-actions)."
4545

46-
## Starter workflows
46+
## Workflow templates
4747

48-
{% data variables.product.product_name %} offers CI starter workflows for a variety of languages and frameworks.
48+
{% data variables.product.product_name %} offers CI workflow templates for a variety of languages and frameworks.
4949

50-
Browse the complete list of CI starter workflows offered by {% data variables.product.company_short %} in the {% ifversion fpt or ghec %}[actions/starter-workflows](https://github.com/actions/starter-workflows/tree/main/ci) repository{% else %} `actions/starter-workflows` repository on {% data variables.location.product_location %}{% endif %}.
50+
Browse the complete list of CI workflow templates offered by {% data variables.product.company_short %} in the {% ifversion fpt or ghec %}[actions/starter-workflows](https://github.com/actions/starter-workflows/tree/main/ci) repository{% else %} `actions/starter-workflows` repository on {% data variables.location.product_location %}{% endif %}.
5151

5252
## Further reading
5353

content/actions/administering-github-actions/sharing-workflows-secrets-and-runners-with-your-organization.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 'Sharing workflows, secrets, and runners with your organization'
33
shortTitle: Share workflows with your organization
4-
intro: 'Learn how you can use organization features to collaborate with your team, by sharing starter workflows, secrets, variables, and self-hosted runners.'
4+
intro: 'Learn how you can use organization features to collaborate with your team, by sharing workflow templates, secrets, variables, and self-hosted runners.'
55
redirect_from:
66
- /actions/learn-github-actions/sharing-workflows-with-your-organization
77
- /actions/learn-github-actions/sharing-workflows-secrets-and-runners-with-your-organization
@@ -17,14 +17,14 @@ type: how_to
1717

1818
## Overview
1919

20-
If you need to share workflows and other {% data variables.product.prodname_actions %} features with your team, then consider collaborating within a {% data variables.product.prodname_dotcom %} organization. An organization allows you to centrally store and manage secrets, artifacts, and self-hosted runners. You can also create starter workflows in the `.github` repository and share them with other users in your organization.
20+
If you need to share workflows and other {% data variables.product.prodname_actions %} features with your team, then consider collaborating within a {% data variables.product.prodname_dotcom %} organization. An organization allows you to centrally store and manage secrets, artifacts, and self-hosted runners. You can also create workflow templates in the `.github` repository and share them with other users in your organization.
2121

2222
## Sharing {% ifversion internal-actions %}actions and {% endif %}workflows
2323

2424
{% ifversion internal-actions %}
25-
You can share both individual actions and entire workflows with your organization, with or without publishing the actions or workflows publicly. You can reuse actions and workflows exactly by referencing them in your workflow file, and you can create starter workflows that provide templates for new workflows.
25+
You can share both individual actions and entire workflows with your organization, with or without publishing the actions or workflows publicly. You can reuse actions and workflows exactly by referencing them in your workflow file, and you can create workflow templates.
2626
{% else %}
27-
Your organization can share workflows by reusing the workflows exactly or by creating starter workflows that provide templates for new workflows.
27+
Your organization can share workflows by reusing the workflows exactly or by creating workflow templates
2828
{% endif %}
2929

3030
{% ifversion internal-actions %}
@@ -38,7 +38,7 @@ Your organization can share workflows by reusing the workflows exactly or by cre
3838

3939
{% data reusables.actions.reusable-workflows %}
4040

41-
### Using starter workflows
41+
### Using workflow templates
4242

4343
{% data reusables.actions.workflow-organization-templates %} For more information, see "[AUTOTITLE](/actions/using-workflows/creating-starter-workflows-for-your-organization)."
4444

content/actions/guides.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ includeGuides:
1717
- /actions/writing-workflows/quickstart
1818
- /actions/about-github-actions/understanding-github-actions
1919
- /actions/sharing-automations/creating-actions/creating-a-docker-container-action
20-
- /actions/writing-workflows/using-starter-workflows
20+
- /actions/writing-workflows/using-workflow-templates
2121
- /actions/use-cases-and-examples/building-and-testing/building-and-testing-python
2222
- /actions/use-cases-and-examples/building-and-testing/building-and-testing-nodejs
2323
- /actions/use-cases-and-examples/publishing-packages/about-packaging-with-github-actions

content/actions/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ featuredLinks:
1414
- /actions/use-cases-and-examples/publishing-packages/about-packaging-with-github-actions
1515
- /actions/monitoring-and-troubleshooting-workflows
1616
guideCards:
17-
- /actions/writing-workflows/using-starter-workflows
17+
- /actions/writing-workflows/using-workflow-templates
1818
- /actions/use-cases-and-examples/publishing-packages/publishing-nodejs-packages
1919
- /actions/use-cases-and-examples/building-and-testing/building-and-testing-powershell
2020
popular:

content/actions/security-for-github-actions/security-guides/security-hardening-for-github-actions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,10 +152,10 @@ With this approach, the value of the {% raw %}`${{ github.event.issue.title }}`{
152152

153153
{% ifversion fpt or ghec %}
154154

155-
### Using starter workflows for {% data variables.product.prodname_code_scanning %}
155+
### Using workflow templates for {% data variables.product.prodname_code_scanning %}
156156

157157
{% data reusables.advanced-security.starter-workflows-beta %}
158-
{% data variables.product.prodname_code_scanning_caps %} allows you to find security vulnerabilities before they reach production. {% data variables.product.product_name %} provides starter workflows for {% data variables.product.prodname_code_scanning %}. You can use these suggested workflows to construct your {% data variables.product.prodname_code_scanning %} workflows, instead of starting from scratch. {% data variables.product.company_short%}'s workflow, the {% data variables.code-scanning.codeql_workflow %}, is powered by {% data variables.product.prodname_codeql %}. There are also third-party starter workflows available.
158+
{% data variables.product.prodname_code_scanning_caps %} allows you to find security vulnerabilities before they reach production. {% data variables.product.product_name %} provides workflow templates for {% data variables.product.prodname_code_scanning %}. You can use these suggested workflows to construct your {% data variables.product.prodname_code_scanning %} workflows, instead of starting from scratch. {% data variables.product.company_short%}'s workflow, the {% data variables.code-scanning.codeql_workflow %}, is powered by {% data variables.product.prodname_codeql %}. There are also third-party workflow templates available.
159159

160160
For more information, see "[AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning)" and "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning#configuring-code-scanning-using-third-party-actions)."
161161

@@ -229,7 +229,7 @@ For more information on how to configure this setting, see {% ifversion ghes or
229229

230230
## Using OpenSSF Scorecards to secure workflows
231231

232-
[Scorecards](https://github.com/ossf/scorecard) is an automated security tool that flags risky supply chain practices. You can use the [Scorecards action](https://github.com/marketplace/actions/ossf-scorecard-action) and [starter workflow](https://github.com/actions/starter-workflows) to follow best security practices. Once configured, the Scorecards action runs automatically on repository changes, and alerts developers about risky supply chain practices using the built-in {% data variables.product.prodname_code_scanning %} experience. The Scorecards project runs a number of checks, including script injection attacks, token permissions, and pinned actions.
232+
[Scorecards](https://github.com/ossf/scorecard) is an automated security tool that flags risky supply chain practices. You can use the [Scorecards action](https://github.com/marketplace/actions/ossf-scorecard-action) and [workflow template](https://github.com/actions/starter-workflows) to follow best security practices. Once configured, the Scorecards action runs automatically on repository changes, and alerts developers about risky supply chain practices using the built-in {% data variables.product.prodname_code_scanning %} experience. The Scorecards project runs a number of checks, including script injection attacks, token permissions, and pinned actions.
233233

234234
## Potential impact of a compromised runner
235235

content/actions/sharing-automations/creating-workflow-templates-for-your-organization.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ topics:
2323

2424
{% data reusables.actions.workflow-organization-templates %}
2525

26-
{% data reusables.actions.starter-workflow-categories %}
26+
{% data reusables.actions.workflow-templates-categories %}
2727

2828
> [!NOTE]
2929
> Because workflow templates require a public `.github` repository, they are not available for {% data variables.product.prodname_emus %}.
@@ -88,7 +88,7 @@ This procedure demonstrates how to create a workflow template and metadata file.
8888
```json copy
8989
{
9090
"name": "Octo Organization Workflow",
91-
"description": "Octo Organization CI starter workflow.",
91+
"description": "Octo Organization CI workflow template.",
9292
"iconName": "example-icon",
9393
"categories": [
9494
"Go"
@@ -113,7 +113,7 @@ This procedure demonstrates how to create a workflow template and metadata file.
113113

114114
* `filePatterns` - **Optional.** Allows the workflow to be used if the user's repository has a file in its root directory that matches a defined regular expression.
115115

116-
To add another starter workflow, add your files to the same `workflow-templates` directory.
116+
To add another workflow template, add your files to the same `workflow-templates` directory.
117117

118118
## Next steps
119119

content/actions/sharing-automations/reusing-workflows.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ You can view the reused workflows referenced in your {% data variables.product.p
4444

4545
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)."
4646

47-
### Reusable workflows and starter workflows
47+
### Reusable workflows and workflow templates
4848

49-
Starter workflows allow everyone in your organization who has permission to create workflows to do so more quickly and easily. When people create a new workflow, they can choose a starter workflow and some or all of the work of writing the workflow will be done for them. Within a starter workflow, you can also reference reusable workflows to make it easy for people to benefit from reusing centrally managed workflow code. If you use a commit SHA when referencing the reusable workflow, you can ensure that everyone who reuses that workflow will always be using the same YAML code. However, if you reference a reusable workflow by a tag or branch, be sure that you can trust that version of the workflow. For more information, see "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#reusing-third-party-workflows)."
49+
Workflow templates allow everyone in your organization who has permission to create workflows to do so more quickly and easily. When people create a new workflow, they can choose a workflow template and some or all of the work of writing the workflow will be done for them. Within a workflow template, you can also reference reusable workflows to make it easy for people to benefit from reusing centrally managed workflow code. If you use a commit SHA when referencing the reusable workflow, you can ensure that everyone who reuses that workflow will always be using the same YAML code. However, if you reference a reusable workflow by a tag or branch, be sure that you can trust that version of the workflow. For more information, see "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#reusing-third-party-workflows)."
5050

5151
For more information, see "[AUTOTITLE](/actions/using-workflows/creating-starter-workflows-for-your-organization)."
5252

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-go.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,23 +27,23 @@ You should already be familiar with YAML syntax and how it's used with {% data v
2727

2828
We recommend that you have a basic understanding of the Go language. For more information, see [Getting started with Go](https://golang.org/doc/tutorial/getting-started).
2929

30-
## Using a Go starter workflow
30+
## Using a Go workflow template
3131

32-
{% data reusables.actions.starter-workflow-get-started %}
32+
{% data reusables.actions.workflow-templates-get-started %}
3333

34-
{% data variables.product.prodname_dotcom %} provides a Go starter workflow that should work for most Go projects. The subsequent sections of this guide give examples of how you can customize this starter workflow.
34+
{% data variables.product.prodname_dotcom %} provides a Go workflow template that should work for most Go projects. The subsequent sections of this guide give examples of how you can customize this workflow template.
3535

3636
{% data reusables.repositories.navigate-to-repo %}
3737
{% data reusables.repositories.actions-tab %}
3838
{% data reusables.actions.new-starter-workflow %}
39-
1. The "Choose a workflow" page shows a selection of recommended starter workflows. Search for "go".
39+
1. The "Choose a workflow" page shows a selection of recommended workflow templates. Search for "go".
4040
1. Filter the selection of workflows by clicking **Continuous integration**.
4141
1. On the "Go - by {% data variables.product.prodname_actions %}" workflow, click **Configure**.
4242

4343
![Screenshot of the "Choose a workflow" page. The "Configure" button on the "Go" workflow is highlighted with an orange outline.](/assets/images/help/actions/starter-workflow-go.png)
4444

4545
{%- ifversion ghes %}
46-
If you don't find the "Go - by {% data variables.product.prodname_actions %}" starter workflow, copy the following workflow code to a new file called `go.yml` in the `.github/workflows` directory of your repository.
46+
If you don't find the "Go - by {% data variables.product.prodname_actions %}" workflow template, copy the following workflow code to a new file called `go.yml` in the `.github/workflows` directory of your repository.
4747

4848
```yaml copy
4949
name: Go

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-java-with-ant.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,21 +35,21 @@ We recommend that you have a basic understanding of Java and the Ant framework.
3535

3636
{% data reusables.actions.enterprise-setup-prereq %}
3737

38-
## Using an Ant starter workflow
38+
## Using an Ant workflow template
3939

40-
{% data reusables.actions.starter-workflow-get-started %}
40+
{% data reusables.actions.workflow-templates-get-started %}
4141

42-
{% data variables.product.prodname_dotcom %} provides a starter workflow for Ant that should work for most Java with Ant projects. The subsequent sections of this guide give examples of how you can customize this starter workflow.
42+
{% data variables.product.prodname_dotcom %} provides a workflow template for Ant that should work for most Java with Ant projects. The subsequent sections of this guide give examples of how you can customize this workflow template.
4343

4444
{% data reusables.repositories.navigate-to-repo %}
4545
{% data reusables.repositories.actions-tab %}
4646
{% data reusables.actions.new-starter-workflow %}
47-
1. The "Choose a workflow" page shows a selection of recommended starter workflows. Search for "Java with Ant".
47+
1. The "Choose a workflow" page shows a selection of recommended workflow templates. Search for "Java with Ant".
4848
1. On the "Java with Ant" workflow, click **Configure**.
4949

5050
{%- ifversion ghes %}
5151

52-
If you don't find the "Java with Ant" starter workflow, copy the following workflow code to a new file called `ant.yml` in the `.github/workflows` directory of your repository.
52+
If you don't find the "Java with Ant" workflow template, copy the following workflow code to a new file called `ant.yml` in the `.github/workflows` directory of your repository.
5353

5454
```yaml copy
5555
name: Java CI
@@ -90,7 +90,7 @@ We recommend that you have a basic understanding of Java and the Ant framework.
9090

9191
You can use the same commands that you use locally to build and test your code.
9292

93-
The starter workflow will run the default target specified in your _build.xml_ file. Your default target will commonly be set to build classes, run tests and package classes into their distributable format, for example, a JAR file.
93+
The workflow template will run the default target specified in your _build.xml_ file. Your default target will commonly be set to build classes, run tests and package classes into their distributable format, for example, a JAR file.
9494

9595
If you use different commands to build your project, or you want to run a different target, you can specify those. For example, you may want to run the `jar` target that's configured in your `_build-ci.xml_` file.
9696

0 commit comments

Comments
 (0)