Sitelet
https://web.archive.org/web/20241012152702/https://docs.github.com/en/actions/writing-workflows
Skip to main content
GitHub Docs
Version:
Free, Pro, & Team
Search GitHub Docs
Search
Select language: current language is English
Open Search Bar
Close Search Bar
Open Menu
Open Sidebar
GitHub Actions
/
Write workflows
Home
GitHub Actions
About GitHub Actions
Understand GitHub Actions
Continuous integration
Continuous deployment
Write workflows
Quickstart
About workflows
Use workflow templates
Choose when workflows run
Trigger a workflow
Use conditions to control job execution
Events that trigger workflows
Choose where workflows run
Choose the runner for a job
Run jobs in a container
Choose what workflows do
Use jobs in a workflow
Find and customize actions
GitHub CLI in workflows
Workflow commands
Add scripts
Permissions for `GITHUB_TOKEN`
Expressions
Variables
Contexts
Pass information
Set default values for jobs
Environments
Concurrency
Run job variations
Cache dependencies
Store artifacts
Workflow syntax
Manage workflows and deployments
Manage workflow runs
Manually run a workflow
Re-run workflows and jobs
Cancel a workflow
Disable & enable a workflow
Skip workflow runs
Delete a workflow run
Download workflow artifacts
Remove workflow artifacts
Approve public fork runs
Approve private fork runs
Manage deployments
Deployment history
Manage environments
Review deployments
Create custom protection rules
Configure custom protection rules
Share automations
Avoid duplication
Create actions
About custom actions
Create a Docker container action
Create a JavaScript action
Create a composite action
Metadata syntax
Dockerfile support
Set exit codes
Release and maintain actions
Publish in GitHub Marketplace
CLI setup action
Reuse workflows
Create workflow templates
Share from your private repository
Share with your organization
Monitor & troubleshoot
Monitor
About monitoring
Notifications for workflow runs
Visualization graph
Workflow run history
View job execution time
Add a status badge
Workflow run logs
Troubleshoot
About troubleshooting
Enable debug logging
Working with GitHub Support
GitHub-hosted runners
About GitHub-hosted runners
About GitHub-hosted runners
Monitor current jobs
Customize runners
Using larger runners
About larger runners
Manage larger runners
Control access to larger runners
Run jobs on larger runners
Private networking
About private networking
Using OIDC
Using WireGuard
Self-hosted runners
Manage self-hosted runners
About self-hosted runners
Add self-hosted runners
Autoscale self-hosted runners
Run a script before or after a job
Customize containers used by jobs
Run the runner app as a service
Proxy servers
Label runners
Use runners in a workflow
Manage access with runner groups
Monitor & troubleshoot
Remove self-hosted runners
Actions Runner Controller
About ARC
Quickstart
Authenticating
Deploying runner scale sets
Using ARC in a workflow
Troubleshoot
About Support for ARC
Security
Security guides
Security hardening
Using secrets
Automatic token authentication
GitHub security features
Artifact attestations
Artifact attestations
Attest with reusable workflows
Artifact attestations Kubernetes admission controller
Verifying attestations offline
Security harden deployments
Security hardening with OpenID Connect
OpenID Connect in AWS
OpenID Connect in Azure
OpenID Connect in Google Cloud Platform
OpenID Connect in HashiCorp Vault
OpenID Connect in JFrog
OpenID Connect in PyPI
OpenID Connect in cloud providers
OpenID Connect with reusable workflows
Use cases and examples
Create an example workflow
Build and test
Build & test Go
Build & test Java & Ant
Build & test Java & Gradle
Build & test Java with Maven
Build & test .NET
Build & test Node.js
Build & test PowerShell
Build & test Python
Build & test Ruby
Build & test Swift
Build & test Xamarin apps
Deployment
Deploy with GitHub Actions
Deploying Node.js to Azure App Service
Deploying Python to Azure App Service
Deploying Java to Azure App Service
Deploying .NET to Azure App Service
Deploying PHP to Azure App Service
Deploying Docker to Azure App Service
Deploying to Azure Static Web App
Deploying to Azure Kubernetes Service
Deploy to Amazon ECS
Deploy to Google Kubernetes Engine
Sign Xcode applications
Publish packages
Packaging with GitHub Actions
Publish Docker images
Publish Java packages with Gradle
Publish Java packages with Maven
Publish Node.js packages
Project management
Actions for project management
Add labels to issues
Close inactive issues
Add label to comment on issue
Schedule issue creation
Containerized services
About service containers
Create PostgreSQL service containers
Create Redis service containers
Migrate to GitHub Actions
Automated migrations
Automate migration with GitHub Actions Importer
Extending GitHub Actions Importer
Supplemental arguments and settings
Azure DevOps migration
Bamboo migration
Bitbucket Pipelines migration
CircleCI migration
GitLab migration
Jenkins migration
Travis CI migration
Manual migrations
Migrate from Azure Pipelines
Migrate from CircleCI
Migrate from GitLab CI/CD
Migrate from Jenkins
Migrate from Travis CI
Administer GitHub Actions
Workflow billing & limits
GitHub Actions usage metrics
Share workflows with your organization
Guides for GitHub Actions
GitHub Actions
/
Write workflows
Writing workflows
GitHub Actions workflows can automate tasks throughout the software development lifecycle.
Quickstart for GitHub Actions
About workflows
Using workflow templates
Choosing when your workflow runs
Triggering a workflow
Using conditions to control job execution
Events that trigger workflows
Choosing where your workflow runs
Choosing the runner for a job
Running jobs in a container
Choosing what your workflow does
Using jobs in a workflow
Using pre-written building blocks in your workflow
Using GitHub CLI in workflows
Workflow commands for GitHub Actions
Adding scripts to your workflow
Controlling permissions for GITHUB_TOKEN
Evaluate expressions in workflows and actions
Store information in variables
Accessing contextual information about workflow runs
Passing information between jobs
Setting a default shell and working directory
Using environments for deployment
Control the concurrency of workflows and jobs
Running variations of jobs in a workflow
Caching dependencies to speed up workflows
Storing and sharing data from a workflow
Workflow syntax for GitHub Actions