Skip to content

Commit 4cfc687

Browse files
authored
Merge branch 'main' into patch-6
2 parents 8462722 + dfc135a commit 4cfc687

138 files changed

Lines changed: 534 additions & 997 deletions

File tree

Some content is hidden

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

.devcontainer/devcontainer.json

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,6 @@
3232
"postCreateCommand": "npm ci && npm run build",
3333

3434
// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
35-
"remoteUser": "node",
36-
37-
// Test restricting low-spec machines
38-
"hostRequirements": {
39-
"cpus": 8,
40-
"memory": "8gb",
41-
"storage": "32gb"
42-
}
35+
"remoteUser": "node"
36+
4337
}
51.1 KB
Loading

components/playground/content/actions/guides/building-and-testing-nodejs-or-python/nodejs.tsx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ const article: PlaygroundArticleT = {
2424
id: '0',
2525
},
2626
type: 'default',
27-
title: 'Starting with the Node.js workflow template',
27+
title: 'Using the Node.js starter workflow',
2828
content: dedent`
29-
GitHub provides a Node.js workflow template that will work for most Node.js projects. This guide includes npm and Yarn examples that you can use to customize the template. For more information, see the [Node.js workflow template](https://github.com/actions/starter-workflows/blob/main/ci/node.js.yml).
29+
GitHub provides a Node.js starter workflow that will work for most Node.js projects. This guide includes npm and Yarn examples that you can use to customize the starter workflow. For more information, see the [Node.js starter workflow](https://github.com/actions/starter-workflows/blob/main/ci/node.js.yml).
3030
31-
To get started quickly, add the template to the \`.github/workflows\` directory of your repository. The example workflow assumes that the default branch for your repository is \`main\`.
31+
To get started quickly, add the starter workflow to the \`.github/workflows\` directory of your repository. The example workflow assumes that the default branch for your repository is \`main\`.
3232
`,
3333
},
3434
{
@@ -39,7 +39,7 @@ const article: PlaygroundArticleT = {
3939
type: 'default',
4040
title: 'Running on a different operating system',
4141
content: dedent`
42-
The starter workflow template configures jobs to run on Linux, using the GitHub-hosted \`ubuntu-latest\` runners. You can change the \`runs-on\` key to run your jobs on a different operating system. For example, you can use the GitHub-hosted Windows runners.
42+
The starter workflow configures jobs to run on Linux, using the GitHub-hosted \`ubuntu-latest\` runners. You can change the \`runs-on\` key to run your jobs on a different operating system. For example, you can use the GitHub-hosted Windows runners.
4343
4444
\`\`\`yaml
4545
runs-on: windows-latest
@@ -66,7 +66,7 @@ const article: PlaygroundArticleT = {
6666
6767
The \`setup-node\` action takes a Node.js version as an input and configures that version on the runner. The \`setup-node\` action finds a specific version of Node.js from the tools cache on each runner and adds the necessary binaries to \`PATH\`, which persists for the rest of the job. Using the \`setup-node\` action is the recommended way of using Node.js with GitHub Actions because it ensures consistent behavior across different runners and different versions of Node.js. If you are using a self-hosted runner, you must install Node.js and add it to \`PATH\`.
6868
69-
The template includes a matrix strategy that builds and tests your code with four Node.js versions: 10.x, 12.x, 14.x, and 15.x. The 'x' is a wildcard character that matches the latest minor and patch release available for a version. Each version of Node.js specified in the \`node-version\` array creates a job that runs the same steps.
69+
The starter workflow includes a matrix strategy that builds and tests your code with four Node.js versions: 10.x, 12.x, 14.x, and 15.x. The 'x' is a wildcard character that matches the latest minor and patch release available for a version. Each version of Node.js specified in the \`node-version\` array creates a job that runs the same steps.
7070
7171
Each job can access the value defined in the matrix \`node-version\` array using the \`matrix\` context. The \`setup-node\` action uses the context as the \`node-version\` input. The \`setup-node\` action configures each job with a different Node.js version before building and testing code. For more information about matrix strategies and contexts, see "[Workflow syntax for GitHub Actions](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix)" and "[Context and expression syntax for GitHub Actions](/actions/reference/context-and-expression-syntax-for-github-actions)."
7272
`,

components/playground/content/actions/guides/building-and-testing-nodejs-or-python/python.tsx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ const article: PlaygroundArticleT = {
2828
codeBlock: {
2929
id: '0',
3030
},
31-
title: 'Starting with the Python workflow template',
31+
title: 'Using the Python starter workflow',
3232
content: dedent`
33-
GitHub provides a Python workflow template that should work for most Python projects. This guide includes examples that you can use to customize the template. For more information, see the [Python workflow template](https://github.com/actions/starter-workflows/blob/main/ci/python-package.yml).
33+
GitHub provides a Python starter workflow that should work for most Python projects. This guide includes examples that you can use to customize the starter workflow. For more information, see the [Python starter workflow](https://github.com/actions/starter-workflows/blob/main/ci/python-package.yml).
3434
35-
To get started quickly, add the template to the \`.github/workflows\` directory of your repository.
35+
To get started quickly, add the starter workflow to the \`.github/workflows\` directory of your repository.
3636
`,
3737
},
3838
{
@@ -206,7 +206,7 @@ const article: PlaygroundArticleT = {
206206
207207
For this example, you will need to create two [PyPI API tokens](https://pypi.org/help/#apitoken). You can use secrets to store the access tokens or credentials needed to publish your package. For more information, see "[Creating and using encrypted secrets](/github/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)."
208208
209-
For more information about the template workflow, see [\`python-publish\`](https://github.com/actions/starter-workflows/blob/main/ci/python-publish.yml).
209+
For more information about the starter workflow, see [\`python-publish\`](https://github.com/actions/starter-workflows/blob/main/ci/python-publish.yml).
210210
`,
211211
},
212212
],

content/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ defaultPlatform: linux
227227

228228
### `defaultTool`
229229

230-
- Purpose: Override the initial tool selection for a page, where tool refers to the application the reader is using to work with GitHub (such as GitHub.com's web UI, the GitHub CLI, or GitHub Desktop) or the GitHub APIs (such as cURL or the GitHub CLI). If this frontmatter is omitted, then the tool-specific content matching the GitHub web UI is shown by default. This behavior can be changed for individual pages, for which a manual selection is more reasonable.
230+
- Purpose: Override the initial tool selection for a page, where tool refers to the application the reader is using to work with GitHub (such as GitHub.com's web UI, the GitHub CLI, or GitHub Desktop) or the GitHub APIs (such as cURL or the GitHub CLI). For more information about the tool selector, see [Markup reference for GitHub Docs](../contributing/content-markup-reference.md#tool-tags). If this frontmatter is omitted, then the tool-specific content matching the GitHub web UI is shown by default. If a user has indicated a tool preference (by clicking on a tool tab), then the user's preference will be applied instead of the default value.
231231
- Type: `String`, one of: `webui`, `cli`, `desktop`, `curl`, `codespaces`, `vscode`.
232232
- Optional.
233233

content/actions/automating-builds-and-tests/about-continuous-integration.md

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

4040
{% 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.
4141

42-
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 template file 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 template, or create your own custom workflow file to run your CI tests.
42+
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.
4343

44-
![Screenshot of suggested continuous integration templates](/assets/images/help/repository/ci-with-actions-template-picker.png)
44+
![Screenshot of suggested continuous integration starter workflows](/assets/images/help/repository/ci-with-actions-template-picker.png)
4545

4646
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 "[About {% data variables.product.prodname_actions %}](/articles/about-github-actions)."
4747

4848
For a definition of common terms, see "[Core concepts for {% data variables.product.prodname_actions %}](/github/automating-your-workflow-with-github-actions/core-concepts-for-github-actions)."
4949

50-
## Workflow templates
50+
## Starter workflow
5151

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

54-
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.product.product_location %}{% endif %}.
54+
Browse the complete list of CI starter workflow 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.product.product_location %}{% endif %}.
5555

5656
## Further reading
5757

content/actions/automating-builds-and-tests/building-and-testing-java-with-ant.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ We recommend that you have a basic understanding of Java and the Ant framework.
4040

4141
{% data reusables.actions.enterprise-setup-prereq %}
4242

43-
## Starting with an Ant workflow template
43+
## Using the Ant starter workflow
4444

45-
{% data variables.product.prodname_dotcom %} provides an Ant workflow template that will work for most Ant-based Java projects. For more information, see the [Ant workflow template](https://github.com/actions/starter-workflows/blob/main/ci/ant.yml).
45+
{% data variables.product.prodname_dotcom %} provides an Ant starter workflow that will work for most Ant-based Java projects. For more information, see the [Ant starter workflow](https://github.com/actions/starter-workflows/blob/main/ci/ant.yml).
4646

47-
To get started quickly, you can choose the preconfigured Ant template when you create a new workflow. For more information, see the "[{% data variables.product.prodname_actions %} quickstart](/actions/quickstart)."
47+
To get started quickly, you can choose the preconfigured Ant starter workflow when you create a new workflow. For more information, see the "[{% data variables.product.prodname_actions %} quickstart](/actions/quickstart)."
4848

4949
You can also add this workflow manually by creating a new file in the `.github/workflows` directory of your repository.
5050

@@ -76,7 +76,7 @@ This workflow performs the following steps:
7676
2. The `setup-java` step configures the Java 11 JDK by Adoptium.
7777
3. The "Build with Ant" step runs the default target in your `build.xml` in non-interactive mode.
7878

79-
The default workflow templates are excellent starting points when creating your build and test workflow, and you can customize the template to suit your project’s needs.
79+
The default starter workflows are excellent starting points when creating your build and test workflow, and you can customize the starter workflow to suit your project’s needs.
8080

8181
{% data reusables.github-actions.example-github-runner %}
8282

content/actions/automating-builds-and-tests/building-and-testing-java-with-gradle.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ We recommend that you have a basic understanding of Java and the Gradle framewor
4040

4141
{% data reusables.actions.enterprise-setup-prereq %}
4242

43-
## Starting with a Gradle workflow template
43+
## Using the Gradle starter workflow
4444

45-
{% data variables.product.prodname_dotcom %} provides a Gradle workflow template that will work for most Gradle-based Java projects. For more information, see the [Gradle workflow template](https://github.com/actions/starter-workflows/blob/main/ci/gradle.yml).
45+
{% data variables.product.prodname_dotcom %} provides a Gradle starter workflow that will work for most Gradle-based Java projects. For more information, see the [Gradle starter workflow](https://github.com/actions/starter-workflows/blob/main/ci/gradle.yml).
4646

47-
To get started quickly, you can choose the preconfigured Gradle template when you create a new workflow. For more information, see the "[{% data variables.product.prodname_actions %} quickstart](/actions/quickstart)."
47+
To get started quickly, you can choose the preconfigured Gradle starter workflow when you create a new workflow. For more information, see the "[{% data variables.product.prodname_actions %} quickstart](/actions/quickstart)."
4848

4949
You can also add this workflow manually by creating a new file in the `.github/workflows` directory of your repository.
5050

@@ -79,7 +79,7 @@ This workflow performs the following steps:
7979
3. The "Validate Gradle wrapper" step validates the checksums of Gradle Wrapper JAR files present in the source tree.
8080
4. The "Build with Gradle" step runs the `gradlew` wrapper script to ensure that your code builds, tests pass, and a package can be created.
8181

82-
The default workflow templates are excellent starting points when creating your build and test workflow, and you can customize the template to suit your project’s needs.
82+
The default starter workflows are excellent starting points when creating your build and test workflow, and you can customize the starter workflow to suit your project’s needs.
8383

8484
{% data reusables.github-actions.example-github-runner %}
8585

content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ We recommend that you have a basic understanding of Java and the Maven framework
4040

4141
{% data reusables.actions.enterprise-setup-prereq %}
4242

43-
## Starting with a Maven workflow template
43+
## Using the Maven starter workflow
4444

45-
{% data variables.product.prodname_dotcom %} provides a Maven workflow template that will work for most Maven-based Java projects. For more information, see the [Maven workflow template](https://github.com/actions/starter-workflows/blob/main/ci/maven.yml).
45+
{% data variables.product.prodname_dotcom %} provides a Maven starter workflow that will work for most Maven-based Java projects. For more information, see the [Maven starter workflow](https://github.com/actions/starter-workflows/blob/main/ci/maven.yml).
4646

47-
To get started quickly, you can choose the preconfigured Maven template when you create a new workflow. For more information, see the "[{% data variables.product.prodname_actions %} quickstart](/actions/quickstart)."
47+
To get started quickly, you can choose the preconfigured Maven starter workflow when you create a new workflow. For more information, see the "[{% data variables.product.prodname_actions %} quickstart](/actions/quickstart)."
4848

4949
You can also add this workflow manually by creating a new file in the `.github/workflows` directory of your repository.
5050

@@ -76,7 +76,7 @@ This workflow performs the following steps:
7676
2. The `setup-java` step configures the Java 11 JDK by Adoptium.
7777
3. The "Build with Maven" step runs the Maven `package` target in non-interactive mode to ensure that your code builds, tests pass, and a package can be created.
7878

79-
The default workflow templates are excellent starting points when creating your build and test workflow, and you can customize the template to suit your project’s needs.
79+
The default starter workflows are excellent starting points when creating your build and test workflow, and you can customize the starter workflow to suit your project’s needs.
8080

8181
{% data reusables.github-actions.example-github-runner %}
8282

content/actions/automating-builds-and-tests/building-and-testing-net.md

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

2929
We recommend that you have a basic understanding of the .NET Core SDK. For more information, see [Getting started with .NET](https://dotnet.microsoft.com/learn).
3030

31-
## Starting with the .NET workflow template
31+
## Using the .NET starter workflow
3232

33-
{% data variables.product.prodname_dotcom %} provides a .NET workflow template that should work for most .NET projects, and this guide includes examples that show you how to customize this template. For more information, see the [.NET workflow template](https://github.com/actions/setup-dotnet).
33+
{% data variables.product.prodname_dotcom %} provides a .NET starter workflow that should work for most .NET projects, and this guide includes examples that show you how to customize this starter workflow. For more information, see the [.NET starter workflow](https://github.com/actions/setup-dotnet).
3434

35-
To get started quickly, add the template to the `.github/workflows` directory of your repository.
35+
To get started quickly, add the starter workflow to the `.github/workflows` directory of your repository.
3636

3737
{% raw %}
3838
```yaml

0 commit comments

Comments
 (0)