Relocate articles into new "About GitHub Actions" and "Writing workflows" categories (#51761)
This commit is contained in:
Siara
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: About continuous deployment
|
||||
shortTitle: Continuous deployment
|
||||
intro: 'You can create custom continuous deployment (CD) workflows directly in your {% data variables.product.prodname_dotcom %} repository with {% data variables.product.prodname_actions %}.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
@@ -8,9 +9,9 @@ versions:
|
||||
type: overview
|
||||
redirect_from:
|
||||
- /actions/deployment/about-continuous-deployment
|
||||
- /actions/deployment/about-deployments/about-continuous-deployment
|
||||
topics:
|
||||
- CD
|
||||
shortTitle: About continuous deployment
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
@@ -7,6 +7,7 @@ redirect_from:
|
||||
- /actions/automating-your-workflow-with-github-actions/about-continuous-integration
|
||||
- /actions/building-and-testing-code-with-continuous-integration/about-continuous-integration
|
||||
- /actions/guides/about-continuous-integration
|
||||
- /actions/automating-builds-and-tests/about-continuous-integration
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
14
content/actions/about-github-actions/index.md
Normal file
14
content/actions/about-github-actions/index.md
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: About GitHub Actions
|
||||
shortTitle: About GitHub Actions
|
||||
intro: '{% data variables.product.prodname_actions %} is a tool that you can use to build automations to assist with each stage of the software development lifecycle. This section describes {% data variables.product.prodname_actions %} concepts, common terminology, and some high level use cases.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
children:
|
||||
- /understanding-github-actions
|
||||
- /about-continuous-integration
|
||||
- /about-continuous-deployment
|
||||
---
|
||||
|
||||
@@ -7,6 +7,8 @@ redirect_from:
|
||||
- /actions/automating-your-workflow-with-github-actions/core-concepts-for-github-actions
|
||||
- /actions/getting-started-with-github-actions/core-concepts-for-github-actions
|
||||
- /actions/learn-github-actions/introduction-to-github-actions
|
||||
- /actions/learn-github-actions/understanding-github-actions
|
||||
- /actions/learn-github-actions/essential-features-of-github-actions
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -16,7 +16,6 @@ redirect_from:
|
||||
- /actions/guides/building-and-testing-nodejs-or-python
|
||||
- /actions/automating-builds-and-tests/building-and-testing-nodejs-or-python
|
||||
children:
|
||||
- /about-continuous-integration
|
||||
- /building-and-testing-go
|
||||
- /building-and-testing-java-with-ant
|
||||
- /building-and-testing-java-with-gradle
|
||||
|
||||
@@ -7,7 +7,6 @@ versions:
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
children:
|
||||
- /about-continuous-deployment
|
||||
- /deploying-with-github-actions
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Guides for {% data variables.product.prodname_actions %}
|
||||
title: 'Guides for {% data variables.product.prodname_actions %}'
|
||||
intro: 'These guides for {% data variables.product.prodname_actions %} include specific use cases and examples to help you configure workflows.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
layout: product-guides
|
||||
@@ -14,16 +14,16 @@ learningTracks:
|
||||
- hosting_your_own_runners
|
||||
- create_actions
|
||||
includeGuides:
|
||||
- /actions/quickstart
|
||||
- /actions/learn-github-actions/understanding-github-actions
|
||||
- /actions/writing-workflows/quickstart
|
||||
- /actions/about-github-actions/understanding-github-actions
|
||||
- /actions/creating-actions/creating-a-docker-container-action
|
||||
- /actions/learn-github-actions/using-starter-workflows
|
||||
- /actions/writing-workflows/using-starter-workflows
|
||||
- /actions/automating-builds-and-tests/building-and-testing-python
|
||||
- /actions/automating-builds-and-tests/building-and-testing-nodejs
|
||||
- /actions/publishing-packages/about-packaging-with-github-actions
|
||||
- /actions/publishing-packages/publishing-docker-images
|
||||
- /actions/using-workflows/caching-dependencies-to-speed-up-workflows
|
||||
- /actions/automating-builds-and-tests/about-continuous-integration
|
||||
- /actions/writing-workflows/choosing-what-your-workflow-does/caching-dependencies-to-speed-up-workflows
|
||||
- /actions/about-github-actions/about-continuous-integration
|
||||
- /actions/automating-builds-and-tests/building-and-testing-powershell
|
||||
- /actions/automating-builds-and-tests/building-and-testing-ruby
|
||||
- /actions/automating-builds-and-tests/building-and-testing-java-with-maven
|
||||
@@ -35,13 +35,12 @@ includeGuides:
|
||||
- /actions/publishing-packages/publishing-nodejs-packages
|
||||
- /actions/publishing-packages/publishing-java-packages-with-maven
|
||||
- /actions/publishing-packages/publishing-java-packages-with-gradle
|
||||
- /actions/using-workflows/storing-workflow-data-as-artifacts
|
||||
- /actions/writing-workflows/choosing-what-your-workflow-does/storing-workflow-data-as-artifacts
|
||||
- /actions/using-containerized-services/about-service-containers
|
||||
- /actions/using-containerized-services/creating-redis-service-containers
|
||||
- /actions/using-containerized-services/creating-postgresql-service-containers
|
||||
- /actions/deployment/deploying-to-your-cloud-provider/deploying-to-amazon-elastic-container-service
|
||||
- /actions/deployment/deploying-to-your-cloud-provider/deploying-to-google-kubernetes-engine
|
||||
- /actions/learn-github-actions/essential-features-of-github-actions
|
||||
- /actions/security-guides/security-hardening-for-github-actions
|
||||
- /actions/creating-actions/about-custom-actions
|
||||
- /actions/creating-actions/creating-a-javascript-action
|
||||
@@ -69,3 +68,4 @@ includeGuides:
|
||||
- /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-static-web-app
|
||||
- /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-kubernetes-service
|
||||
---
|
||||
|
||||
|
||||
@@ -77,7 +77,7 @@ If you get a "permission denied" error when you attempt to run a script, make su
|
||||
chmod +x PATH/TO/FILE
|
||||
```
|
||||
|
||||
For information about using workflows to run scripts, see "[AUTOTITLE](/actions/learn-github-actions/essential-features-of-github-actions#adding-scripts-to-your-workflow)."
|
||||
For information about using workflows to run scripts, see "[AUTOTITLE](/actions/writing-workflows/choosing-what-your-workflow-does/adding-scripts-to-your-workflow)."
|
||||
|
||||
### No timeout setting
|
||||
|
||||
|
||||
@@ -3,28 +3,28 @@ title: '{% data variables.product.prodname_actions %} documentation'
|
||||
shortTitle: '{% data variables.product.prodname_actions %}'
|
||||
intro: 'Automate, customize, and execute your software development workflows right in your repository with {% data variables.product.prodname_actions %}. You can discover, create, and share actions to perform any job you''d like, including CI/CD, and combine actions in a completely customized workflow.'
|
||||
introLinks:
|
||||
overview: /actions/learn-github-actions/understanding-github-actions
|
||||
quickstart: /actions/quickstart
|
||||
overview: /actions/about-github-actions/understanding-github-actions
|
||||
quickstart: /actions/writing-workflows/quickstart
|
||||
featuredLinks:
|
||||
startHere:
|
||||
- /actions/learn-github-actions
|
||||
- /actions/writing-workflows
|
||||
- /actions/examples
|
||||
- /actions/automating-builds-and-tests/about-continuous-integration
|
||||
- /actions/about-github-actions/about-continuous-integration
|
||||
- /actions/deployment/about-deployments/deploying-with-github-actions
|
||||
- /actions/publishing-packages/about-packaging-with-github-actions
|
||||
- /actions/monitoring-and-troubleshooting-workflows
|
||||
guideCards:
|
||||
- /actions/learn-github-actions/using-starter-workflows
|
||||
- /actions/writing-workflows/using-starter-workflows
|
||||
- /actions/publishing-packages/publishing-nodejs-packages
|
||||
- /actions/automating-builds-and-tests/building-and-testing-powershell
|
||||
popular:
|
||||
- /actions/using-workflows/workflow-syntax-for-github-actions
|
||||
- /actions/learn-github-actions
|
||||
- /actions/writing-workflows/workflow-syntax-for-github-actions
|
||||
- /actions/writing-workflows
|
||||
- /actions/examples
|
||||
- /actions/using-workflows/events-that-trigger-workflows
|
||||
- /actions/learn-github-actions/contexts
|
||||
- /actions/learn-github-actions/expressions
|
||||
- /actions/learn-github-actions/variables
|
||||
- /actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows
|
||||
- /actions/writing-workflows/choosing-what-your-workflow-does/contexts
|
||||
- /actions/writing-workflows/choosing-what-your-workflow-does/expressions
|
||||
- /actions/writing-workflows/choosing-what-your-workflow-does/variables
|
||||
- /actions/security-guides/using-secrets-in-github-actions
|
||||
changelog:
|
||||
label: actions
|
||||
@@ -42,11 +42,10 @@ versions:
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
children:
|
||||
- /quickstart
|
||||
- /learn-github-actions
|
||||
- /about-github-actions
|
||||
- /examples
|
||||
- /writing-workflows
|
||||
- /using-workflows
|
||||
- /using-jobs
|
||||
- /managing-workflow-runs
|
||||
- /automating-builds-and-tests
|
||||
- /deployment
|
||||
|
||||
@@ -1,131 +0,0 @@
|
||||
---
|
||||
title: Essential features of GitHub Actions
|
||||
shortTitle: Essential features
|
||||
intro: '{% data variables.product.prodname_actions %} are designed to help you build robust and dynamic automations. This guide will show you how to craft {% data variables.product.prodname_actions %} workflows that include environment variables, customized scripts, and more.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
type: overview
|
||||
topics:
|
||||
- Fundamentals
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
|
||||
## Overview
|
||||
|
||||
{% data variables.product.prodname_actions %} allow you to customize your workflows to meet the unique needs of your application and team. In this guide, we'll discuss some of the essential customization techniques such as using variables, running scripts, and sharing data and artifacts between jobs.
|
||||
|
||||
## Using variables in your workflows
|
||||
|
||||
{% data variables.product.prodname_actions %} include default environment variables for each workflow run. If you need to use custom environment variables, you can set these in your YAML workflow file. This example demonstrates how to create custom variables named `POSTGRES_HOST` and `POSTGRES_PORT`. These variables are then available to the `node client.js` script.
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
example-job:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Connect to PostgreSQL
|
||||
run: node client.js
|
||||
env:
|
||||
POSTGRES_HOST: postgres
|
||||
POSTGRES_PORT: 5432
|
||||
```
|
||||
|
||||
For more information, see "[AUTOTITLE](/actions/learn-github-actions/variables#default-environment-variables)."
|
||||
|
||||
## Adding scripts to your workflow
|
||||
|
||||
You can use a {% data variables.product.prodname_actions %} workflow to run scripts and shell commands, which are then executed on the assigned runner. This example demonstrates how to use the `run` keyword to execute the command `npm install -g bats` on the runner.
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
example-job:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- run: npm install -g bats
|
||||
```
|
||||
|
||||
To use a workflow to run a script stored in your repository you must first check out the repository to the runner. Having done this, you can use the `run` keyword to run the script on the runner. The following example runs two scripts, each in a separate job step. The location of the scripts on the runner is specified by setting a default working directory for run commands. For more information, see "[AUTOTITLE](/actions/using-jobs/setting-default-values-for-jobs)."
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
example-job:
|
||||
runs-on: ubuntu-latest
|
||||
defaults:
|
||||
run:
|
||||
working-directory: ./scripts
|
||||
steps:
|
||||
- name: Check out the repository to the runner
|
||||
uses: {% data reusables.actions.action-checkout %}
|
||||
- name: Run a script
|
||||
run: ./my-script.sh
|
||||
- name: Run another script
|
||||
run: ./my-other-script.sh
|
||||
```
|
||||
|
||||
Any scripts that you want a workflow job to run must be executable. You can do this either within the workflow by passing the script as an argument to the interpreter that will run the script - for example, `run: bash script.sh` - or by making the file itself executable. You can give the file the execute permission by using the command `git update-index --chmod=+x PATH/TO/YOUR/script.sh` locally, then committing and pushing the file to the repository. Alternatively, for workflows that are run on Linux and Mac runners, you can add a command to give the file the execute permission in the workflow job, prior to running the script:
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
example-job:
|
||||
runs-on: ubuntu-latest
|
||||
defaults:
|
||||
run:
|
||||
working-directory: ./scripts
|
||||
steps:
|
||||
- name: Check out the repository to the runner
|
||||
uses: {% data reusables.actions.action-checkout %}
|
||||
- name: Make the script files executable
|
||||
run: chmod +x my-script.sh my-other-script.sh
|
||||
- name: Run the scripts
|
||||
run: |
|
||||
./my-script.sh
|
||||
./my-other-script.sh
|
||||
```
|
||||
|
||||
For more information about the `run` keyword, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)."
|
||||
|
||||
## Sharing data between jobs
|
||||
|
||||
If your job generates files that you want to share with another job in the same workflow, or if you want to save the files for later reference, you can store them in {% data variables.product.prodname_dotcom %} as _artifacts_. Artifacts are the files created when you build and test your code. For example, artifacts might include binary or package files, test results, screenshots, or log files. Artifacts are associated with the workflow run where they were created and can be used by another job. {% data reusables.actions.reusable-workflow-artifacts %}
|
||||
|
||||
For example, you can create a file and then upload it as an artifact.
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
example-job:
|
||||
name: Save output
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- shell: bash
|
||||
run: |
|
||||
expr 1 + 1 > output.log
|
||||
- name: Upload output file
|
||||
uses: {% data reusables.actions.action-upload-artifact %}
|
||||
with:
|
||||
name: output-log-file
|
||||
path: output.log
|
||||
```
|
||||
|
||||
To download an artifact from a separate workflow run, you can use the `actions/download-artifact` action. For example, you can download the artifact named `output-log-file`.
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
example-job:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Download a single artifact
|
||||
uses: {% data reusables.actions.action-download-artifact %}
|
||||
with:
|
||||
name: output-log-file
|
||||
```
|
||||
|
||||
To download an artifact from the same workflow run, your download job should specify `needs: upload-job-name` so it doesn't start until the upload job finishes.
|
||||
|
||||
For more information about artifacts, see "[AUTOTITLE](/actions/using-workflows/storing-workflow-data-as-artifacts)."
|
||||
|
||||
## Next steps
|
||||
|
||||
To continue learning about {% data variables.product.prodname_actions %}, see "[AUTOTITLE](/actions/using-workflows/about-workflows)."
|
||||
@@ -1,29 +0,0 @@
|
||||
---
|
||||
title: Learn GitHub Actions
|
||||
shortTitle: Learn GitHub Actions
|
||||
intro: 'Whether you are new to {% data variables.product.prodname_actions %} or interested in learning all they have to offer, this guide will help you use {% data variables.product.prodname_actions %} to accelerate your application development workflows.'
|
||||
redirect_from:
|
||||
- /articles/about-github-actions
|
||||
- /actions/getting-started-with-github-actions
|
||||
- /actions/getting-started-with-github-actions/about-github-actions
|
||||
- /actions/getting-started-with-github-actions/overview
|
||||
- /actions/getting-started-with-github-actions/getting-started-with-github-actions
|
||||
- /articles/getting-started-with-github-actions
|
||||
- /github/automating-your-workflow-with-github-actions/about-github-actions
|
||||
- /actions/automating-your-workflow-with-github-actions/about-github-actions
|
||||
- /github/automating-your-workflow-with-github-actions/getting-started-with-github-actions
|
||||
- /actions/automating-your-workflow-with-github-actions/getting-started-with-github-actions
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
children:
|
||||
- /understanding-github-actions
|
||||
- /finding-and-customizing-actions
|
||||
- /essential-features-of-github-actions
|
||||
- /expressions
|
||||
- /contexts
|
||||
- /variables
|
||||
- /using-starter-workflows
|
||||
---
|
||||
|
||||
@@ -1,23 +0,0 @@
|
||||
---
|
||||
title: Using jobs
|
||||
shortTitle: Using jobs
|
||||
intro: 'Creating and managing {% data variables.product.prodname_actions %} jobs.'
|
||||
redirect_from:
|
||||
- /actions/jobs
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
children:
|
||||
- /using-jobs-in-a-workflow
|
||||
- /choosing-the-runner-for-a-job
|
||||
- /using-conditions-to-control-job-execution
|
||||
- /using-a-matrix-for-your-jobs
|
||||
- /using-concurrency
|
||||
- /using-environments-for-deployment
|
||||
- /running-jobs-in-a-container
|
||||
- /setting-default-values-for-jobs
|
||||
- /assigning-permissions-to-jobs
|
||||
- /defining-outputs-for-jobs
|
||||
---
|
||||
|
||||
@@ -21,18 +21,11 @@ versions:
|
||||
ghec: '*'
|
||||
children:
|
||||
- /about-workflows
|
||||
- /triggering-a-workflow
|
||||
- /manually-running-a-workflow
|
||||
- /disabling-and-enabling-a-workflow
|
||||
- /events-that-trigger-workflows
|
||||
- /workflow-syntax-for-github-actions
|
||||
- /workflow-commands-for-github-actions
|
||||
- /avoiding-duplication
|
||||
- /reusing-workflows
|
||||
- /required-workflows
|
||||
- /caching-dependencies-to-speed-up-workflows
|
||||
- /storing-workflow-data-as-artifacts
|
||||
- /creating-starter-workflows-for-your-organization
|
||||
- /using-github-cli-in-workflows
|
||||
---
|
||||
|
||||
|
||||
@@ -0,0 +1,59 @@
|
||||
---
|
||||
title: Adding scripts to your workflow
|
||||
shortTitle: Add scripts
|
||||
intro: 'You can use {% data variables.product.prodname_actions %} workflows to run scripts.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
---
|
||||
|
||||
You can use a {% data variables.product.prodname_actions %} workflow to run scripts and shell commands, which are then executed on the assigned runner. This example demonstrates how to use the `run` keyword to execute the command `npm install -g bats` on the runner.
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
example-job:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- run: npm install -g bats
|
||||
```
|
||||
|
||||
To use a workflow to run a script stored in your repository you must first check out the repository to the runner. Having done this, you can use the `run` keyword to run the script on the runner. The following example runs two scripts, each in a separate job step. The location of the scripts on the runner is specified by setting a default working directory for run commands. For more information, see "[AUTOTITLE](/actions/using-jobs/setting-default-values-for-jobs)."
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
example-job:
|
||||
runs-on: ubuntu-latest
|
||||
defaults:
|
||||
run:
|
||||
working-directory: ./scripts
|
||||
steps:
|
||||
- name: Check out the repository to the runner
|
||||
uses: {% data reusables.actions.action-checkout %}
|
||||
- name: Run a script
|
||||
run: ./my-script.sh
|
||||
- name: Run another script
|
||||
run: ./my-other-script.sh
|
||||
```
|
||||
|
||||
Any scripts that you want a workflow job to run must be executable. You can do this either within the workflow by passing the script as an argument to the interpreter that will run the script - for example, `run: bash script.sh` - or by making the file itself executable. You can give the file the execute permission by using the command `git update-index --chmod=+x PATH/TO/YOUR/script.sh` locally, then committing and pushing the file to the repository. Alternatively, for workflows that are run on Linux and Mac runners, you can add a command to give the file the execute permission in the workflow job, prior to running the script:
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
example-job:
|
||||
runs-on: ubuntu-latest
|
||||
defaults:
|
||||
run:
|
||||
working-directory: ./scripts
|
||||
steps:
|
||||
- name: Check out the repository to the runner
|
||||
uses: {% data reusables.actions.action-checkout %}
|
||||
- name: Make the script files executable
|
||||
run: chmod +x my-script.sh my-other-script.sh
|
||||
- name: Run the scripts
|
||||
run: |
|
||||
./my-script.sh
|
||||
./my-other-script.sh
|
||||
```
|
||||
|
||||
For more information about the `run` keyword, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)."
|
||||
@@ -6,6 +6,8 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '> 3.1'
|
||||
ghec: '*'
|
||||
redirect_from:
|
||||
- /actions/using-jobs/assigning-permissions-to-jobs
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
@@ -8,6 +8,7 @@ redirect_from:
|
||||
- /actions/configuring-and-managing-workflows/caching-dependencies-to-speed-up-workflows
|
||||
- /actions/guides/caching-dependencies-to-speed-up-workflows
|
||||
- /actions/advanced-guides/caching-dependencies-to-speed-up-workflows
|
||||
- /actions/using-workflows/caching-dependencies-to-speed-up-workflows
|
||||
versions:
|
||||
feature: actions-caching
|
||||
type: tutorial
|
||||
@@ -8,6 +8,7 @@ redirect_from:
|
||||
- /actions/automating-your-workflow-with-github-actions/contexts-and-expression-syntax-for-github-actions
|
||||
- /actions/reference/contexts-and-expression-syntax-for-github-actions
|
||||
- /actions/reference/context-and-expression-syntax-for-github-actions
|
||||
- /actions/learn-github-actions/contexts
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -6,6 +6,8 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
redirect_from:
|
||||
- /actions/using-jobs/defining-outputs-for-jobs
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
@@ -6,6 +6,8 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
redirect_from:
|
||||
- /actions/learn-github-actions/expressions
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
@@ -7,6 +7,7 @@ redirect_from:
|
||||
- /actions/automating-your-workflow-with-github-actions/using-actions-from-github-marketplace-in-your-workflow
|
||||
- /actions/getting-started-with-github-actions/using-actions-from-github-marketplace
|
||||
- /actions/getting-started-with-github-actions/using-community-workflows-and-actions
|
||||
- /actions/learn-github-actions/finding-and-customizing-actions
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -0,0 +1,29 @@
|
||||
---
|
||||
title: Choosing what your workflow does
|
||||
shortTitle: Choose what workflows do
|
||||
intro: 'Workflows automate tasks in your software development lifecycle. Many tasks that you manually complete can be converted to a {% data variables.product.prodname_actions %} workflow.'
|
||||
redirect_from:
|
||||
- /actions/using-jobs
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
children:
|
||||
- /using-jobs-in-a-workflow
|
||||
- /finding-and-customizing-actions
|
||||
- /using-github-cli-in-workflows
|
||||
- /workflow-commands-for-github-actions
|
||||
- /adding-scripts-to-your-workflow
|
||||
- /assigning-permissions-to-jobs
|
||||
- /expressions
|
||||
- /variables
|
||||
- /contexts
|
||||
- /defining-outputs-for-jobs
|
||||
- /setting-default-values-for-jobs
|
||||
- /using-environments-for-deployment
|
||||
- /using-concurrency
|
||||
- /using-a-matrix-for-your-jobs
|
||||
- /caching-dependencies-to-speed-up-workflows
|
||||
- /storing-workflow-data-as-artifacts
|
||||
---
|
||||
|
||||
@@ -6,6 +6,8 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
redirect_from:
|
||||
- /actions/using-jobs/setting-default-values-for-jobs
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
@@ -9,6 +9,7 @@ redirect_from:
|
||||
- /actions/configuring-and-managing-workflows/persisting-workflow-data-using-artifacts
|
||||
- /actions/guides/storing-workflow-data-as-artifacts
|
||||
- /actions/advanced-guides/storing-workflow-data-as-artifacts
|
||||
- /actions/using-workflows/storing-workflow-data-as-artifacts
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -8,6 +8,7 @@ versions:
|
||||
ghec: '*'
|
||||
redirect_from:
|
||||
- /actions/using-jobs/using-a-build-matrix-for-your-jobs
|
||||
- /actions/using-jobs/using-a-matrix-for-your-jobs
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
@@ -6,6 +6,8 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '> 3.1'
|
||||
ghec: '*'
|
||||
redirect_from:
|
||||
- /actions/using-jobs/using-concurrency
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
@@ -8,6 +8,7 @@ versions:
|
||||
ghec: '*'
|
||||
redirect_from:
|
||||
- /actions/using-jobs/using-environments-for-jobs
|
||||
- /actions/using-jobs/using-environments-for-deployment
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
@@ -5,6 +5,7 @@ intro: 'You can script with {% data variables.product.prodname_cli %} in {% data
|
||||
redirect_from:
|
||||
- /actions/guides/using-github-cli-in-workflows
|
||||
- /actions/advanced-guides/using-github-cli-in-workflows
|
||||
- /actions/using-workflows/using-github-cli-in-workflows
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -6,6 +6,8 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
redirect_from:
|
||||
- /actions/using-jobs/using-jobs-in-a-workflow
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
@@ -7,6 +7,7 @@ redirect_from:
|
||||
- /actions/configuring-and-managing-workflows/using-environment-variables
|
||||
- /actions/reference/environment-variables
|
||||
- /actions/learn-github-actions/environment-variables
|
||||
- /actions/learn-github-actions/variables
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -11,6 +11,7 @@ redirect_from:
|
||||
- /actions/reference/logging-commands-for-github-actions
|
||||
- /actions/reference/workflow-commands-for-github-actions
|
||||
- /actions/learn-github-actions/workflow-commands-for-github-actions
|
||||
- /actions/using-workflows/workflow-commands-for-github-actions
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -7,6 +7,7 @@ redirect_from:
|
||||
- /actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows
|
||||
- /actions/reference/events-that-trigger-workflows
|
||||
- /actions/learn-github-actions/events-that-trigger-workflows
|
||||
- /actions/using-workflows/events-that-trigger-workflows
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Choosing when your workflow runs
|
||||
shortTitle: Choose when workflows run
|
||||
intro: You can configure workflows to run on a schedule or to run when certain events happen.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
children:
|
||||
- /triggering-a-workflow
|
||||
- /using-conditions-to-control-job-execution
|
||||
- /events-that-trigger-workflows
|
||||
---
|
||||
|
||||
@@ -11,6 +11,8 @@ topics:
|
||||
- Workflows
|
||||
- CI
|
||||
- CD
|
||||
redirect_from:
|
||||
- /actions/using-workflows/triggering-a-workflow
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
@@ -6,6 +6,8 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
redirect_from:
|
||||
- /actions/using-jobs/using-conditions-to-control-job-execution
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
@@ -6,6 +6,8 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
redirect_from:
|
||||
- /actions/using-jobs/choosing-the-runner-for-a-job
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: Choosing where your workflow runs
|
||||
shortTitle: Choose where workflows run
|
||||
intro: You can specify the compute environment your jobs and workflows run in.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
children:
|
||||
- /choosing-the-runner-for-a-job
|
||||
- /running-jobs-in-a-container
|
||||
---
|
||||
|
||||
@@ -6,6 +6,8 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
redirect_from:
|
||||
- /actions/using-jobs/running-jobs-in-a-container
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
19
content/actions/writing-workflows/index.md
Normal file
19
content/actions/writing-workflows/index.md
Normal file
@@ -0,0 +1,19 @@
|
||||
---
|
||||
title: Writing workflows
|
||||
shortTitle: Write workflows
|
||||
intro: '{% data variables.product.prodname_actions %} workflows can automate tasks throughout the software development lifecycle.'
|
||||
redirect_from:
|
||||
- /actions/learn-github-actions
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
children:
|
||||
- /quickstart
|
||||
- /using-starter-workflows
|
||||
- /choosing-when-your-workflow-runs
|
||||
- /choosing-where-your-workflow-runs
|
||||
- /choosing-what-your-workflow-does
|
||||
- /workflow-syntax-for-github-actions
|
||||
---
|
||||
|
||||
@@ -4,6 +4,7 @@ intro: 'Try out the features of {% data variables.product.prodname_actions %} in
|
||||
allowTitleToDifferFromFilename: true
|
||||
redirect_from:
|
||||
- /actions/getting-started-with-github-actions/starting-with-preconfigured-workflow-templates
|
||||
- /actions/quickstart
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -10,6 +10,7 @@ redirect_from:
|
||||
- /actions/guides/setting-up-continuous-integration-using-workflow-templates
|
||||
- /actions/learn-github-actions/using-workflow-templates
|
||||
- /actions/using-workflows/using-starter-workflows
|
||||
- /actions/learn-github-actions/using-starter-workflows
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -8,6 +8,7 @@ redirect_from:
|
||||
- /actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions
|
||||
- /actions/reference/workflow-syntax-for-github-actions
|
||||
- /actions/learn-github-actions/workflow-syntax-for-github-actions
|
||||
- /actions/using-workflows/workflow-syntax-for-github-actions
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -683,7 +684,7 @@ Using the `working-directory` keyword, you can specify the working directory of
|
||||
|
||||
Alternatively, you can specify a default working directory for all `run` steps in a job, or for all `run` steps in the entire workflow. For more information, see "[`defaults.run.working-directory`](/actions/using-workflows/workflow-syntax-for-github-actions#defaultsrunworking-directory)" and "[`jobs.<job_id>.defaults.run.working-directory`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_iddefaultsrunworking-directory)."
|
||||
|
||||
You can also use a `run` step to run a script. For more information, see "[AUTOTITLE](/actions/learn-github-actions/essential-features-of-github-actions#adding-scripts-to-your-workflow)."
|
||||
You can also use a `run` step to run a script. For more information, see "[AUTOTITLE](/actions/writing-workflows/choosing-what-your-workflow-does/adding-scripts-to-your-workflow)."
|
||||
|
||||
## `jobs.<job_id>.steps[*].shell`
|
||||
|
||||
@@ -16,7 +16,7 @@ featuredLinks:
|
||||
startHere:
|
||||
- /github-cli/github-cli/creating-github-cli-extensions
|
||||
- /github-cli/github-cli/using-github-cli-extensions
|
||||
- /actions/using-workflows/using-github-cli-in-workflows
|
||||
- /actions/writing-workflows/choosing-what-your-workflow-does/using-github-cli-in-workflows
|
||||
- /codespaces/developing-in-a-codespace/using-github-codespaces-with-github-cli
|
||||
popular:
|
||||
- /pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
|
||||
|
||||
@@ -4,9 +4,8 @@ getting_started:
|
||||
Discover the possibilities of {% data variables.product.prodname_actions %}
|
||||
by creating your first workflow.
|
||||
guides:
|
||||
- /actions/learn-github-actions/understanding-github-actions
|
||||
- /actions/learn-github-actions/finding-and-customizing-actions
|
||||
- /actions/learn-github-actions/essential-features-of-github-actions
|
||||
- /actions/about-github-actions/understanding-github-actions
|
||||
- /actions/writing-workflows/choosing-what-your-workflow-does/finding-and-customizing-actions
|
||||
- /actions/using-workflows/about-workflows
|
||||
- /actions/using-workflows/reusing-workflows
|
||||
- /actions/security-guides/security-hardening-for-github-actions
|
||||
@@ -20,7 +19,7 @@ adopting_github_actions_for_your_enterprise_ghec:
|
||||
guides:
|
||||
- >-
|
||||
/admin/managing-github-actions-for-your-enterprise/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises
|
||||
- /actions/learn-github-actions/understanding-github-actions
|
||||
- /actions/about-github-actions/understanding-github-actions
|
||||
- >-
|
||||
/admin/managing-github-actions-for-your-enterprise/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise
|
||||
- >-
|
||||
@@ -40,7 +39,7 @@ adopting_github_actions_for_your_enterprise_ghes:
|
||||
guides:
|
||||
- >-
|
||||
/admin/managing-github-actions-for-your-enterprise/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises
|
||||
- /actions/learn-github-actions/understanding-github-actions
|
||||
- /actions/about-github-actions/understanding-github-actions
|
||||
- >-
|
||||
/admin/managing-github-actions-for-your-enterprise/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise
|
||||
- >-
|
||||
|
||||
@@ -43,7 +43,7 @@ adopting_github_actions_for_your_enterprise_ghec:
|
||||
guides:
|
||||
- >-
|
||||
/admin/managing-github-actions-for-your-enterprise/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises
|
||||
- /actions/learn-github-actions/understanding-github-actions
|
||||
- /actions/about-github-actions/understanding-github-actions
|
||||
- >-
|
||||
/admin/managing-github-actions-for-your-enterprise/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise
|
||||
- >-
|
||||
@@ -63,7 +63,7 @@ adopting_github_actions_for_your_enterprise_ghes:
|
||||
guides:
|
||||
- >-
|
||||
/admin/managing-github-actions-for-your-enterprise/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises
|
||||
- /actions/learn-github-actions/understanding-github-actions
|
||||
- /actions/about-github-actions/understanding-github-actions
|
||||
- >-
|
||||
/admin/managing-github-actions-for-your-enterprise/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise
|
||||
- >-
|
||||
|
||||
Reference in New Issue
Block a user