The Wayback Machine - https://web.archive.org/web/20210515183443/https://docs.github.com/en/actions/guides

Explore by product

GitHub Actions
GitHub.com
English

GitHub Actions guides

These guides for GitHub Actions include specific use cases and examples to help you configure workflows.

GitHub Actions learning paths

Learning paths are a collection of guides that help you master a particular subject.
Build and test code

You can create custom continuous integration (CI) workflows right in your repository.

Start
6 more guides
Automate your deployments

Learn how to automate release publishing for your project with a custom continuous deployment (CD) workflow in GitHub Actions.

Start
1 more guides
Deploy to the cloud

Learn how to use GitHub Actions to build an application and deploy it to various cloud-based platforms.

Start
Host your own runners

You can create self-hosted runners to run workflows in a highly customizable environment.

Start
4 more guides
Create an action

Do you have an idea for a new action? Have you built something custom for your project? Learn how to build shareable actions and publish them to GitHub Marketplace.

Start
4 more guides

All GitHub Actions guides

Quickstart for GitHub Actions

Quickstart

Try out the features of GitHub Actions in 5 minutes or less.

Fundamentals

Introduction to GitHub Actions

Overview

Learn about the core concepts and various components of GitHub Actions, and see an example that shows you how to add automation to your repository.

Fundamentals

Creating a Docker container action

Tutorial

This guide shows you the minimal steps required to build a Docker container action.

Action development Docker

Setting up continuous integration using workflow templates

Tutorial

You can set up continuous integration for your project using a workflow template that matches the language and tooling you want to use.

Workflows CI

Building and testing Python

Tutorial

You can create a continuous integration (CI) workflow to build and test your Python project.

CI Python

Building and testing Node.js

Tutorial

You can create a continuous integration (CI) workflow to build and test your Node.js project.

CI Node JavaScript

About packaging with GitHub Actions

Overview

You can set up workflows in GitHub Actions to produce packages and upload them to GitHub Packages or another package hosting provider.

Packaging

Publishing Docker images

Tutorial

You can publish Docker images to a registry, such as Docker Hub or GitHub Packages, as part of your continuous integration (CI) workflow.

Packaging Publishing Docker

Caching dependencies to speed up workflows

Tutorial

To make your workflows faster and more efficient, you can create and use caches for dependencies and other commonly reused files.

Workflows

About continuous integration

Overview

You can create custom continuous integration (CI) and continuous deployment (CD) workflows directly in your GitHub repository with GitHub Actions.

CI CD

Building and testing PowerShell

Tutorial

You can create a continuous integration (CI) workflow to build and test your PowerShell project.

CI Powershell

Building and testing Ruby

Tutorial

You can create a continuous integration (CI) workflow to build and test your Ruby project.

CI Ruby

Building and testing Java with Maven

Tutorial

You can create a continuous integration (CI) workflow in GitHub Actions to build and test your Java project with Maven.

CI Java Maven

Building and testing Java with Gradle

Tutorial

You can create a continuous integration (CI) workflow in GitHub Actions to build and test your Java project with Gradle.

CI Java Gradle

Building and testing Java with Ant

Tutorial

You can create a continuous integration (CI) workflow in GitHub Actions to build and test your Java project with Ant.

CI Java Ant

Installing an Apple certificate on macOS runners for Xcode development

Tutorial

You can sign Xcode apps within your continuous integration (CI) workflow by installing an Apple code signing certificate on GitHub Actions runners.

CI Xcode

Building and testing Xamarin applications

Tutorial

You can create a continuous integration (CI) workflow in GitHub Actions to build and test your Xamarin application.

CI Xamarin Xamarin.iOS Xamarin.Android Android iOS

Publishing Node.js packages

Tutorial

You can publish Node.js packages to a registry as part of your continuous integration (CI) workflow.

Packaging Publishing Node JavaScript

Publishing Java packages with Maven

Tutorial

You can use Maven to publish Java packages to a registry as part of your continuous integration (CI) workflow.

Packaging Publishing Java Maven

Publishing Java packages with Gradle

Tutorial

You can use Gradle to publish Java packages to a registry as part of your continuous integration (CI) workflow.

Packaging Publishing Java Gradle

Storing workflow data as artifacts

Tutorial

Artifacts allow you to share data between jobs in a workflow and store data once that workflow has completed.

Workflows

About service containers

Overview

You can use service containers to connect databases, web services, memory caches, and other tools to your workflow.

Containers Docker

Creating Redis service containers

Tutorial

You can use service containers to create a Redis client in your workflow. This guide shows examples of creating a Redis service for jobs that run in containers or directly on the runner machine.

Containers Docker

Creating PostgreSQL service containers

Tutorial

You can create a PostgreSQL service container to use in your workflow. This guide shows examples of creating a PostgreSQL service for jobs that run in containers or directly on the runner machine.

Containers Docker

Deploying to Amazon Elastic Container Service

Tutorial

You can deploy to Amazon Elastic Container Service (ECS) as part of your continuous deployment (CD) workflows.

CD Containers Amazon ECS

Deploying to Azure App Service

Tutorial

You can deploy to Azure App Service as part of your continuous deployment (CD) workflows.

CD Containers Azure App Service

Deploying to Google Kubernetes Engine

Tutorial

You can deploy to Google Kubernetes Engine as part of your continuous deployment (CD) workflows.

CD Containers Google Kubernetes Engine

Essential features of GitHub Actions

Overview

GitHub Actions are designed to help you build robust and dynamic automations. This guide will show you how to craft GitHub Actions workflows that include environment variables, customized scripts, and more.

Fundamentals

Security hardening for GitHub Actions

Overview

Good security practices for using GitHub Actions features.

Security

About actions

Overview

Actions are individual tasks that you can combine to create jobs and customize your workflow. You can create your own actions, or use and customize actions shared by the GitHub community.

Action development Fundamentals

Creating a JavaScript action

Tutorial

In this guide, you'll learn how to build a JavaScript action using the actions toolkit.

Action development JavaScript

Creating a composite run steps action

Tutorial

In this guide, you'll learn how to build a composite run steps action.

Action development

Migrating from Azure Pipelines to GitHub Actions

Tutorial

GitHub Actions and Azure Pipelines share several configuration similarities, which makes migrating to GitHub Actions relatively straightforward.

Azure Pipelines Migration CI CD

Migrating from CircleCI to GitHub Actions

Tutorial

GitHub Actions and CircleCI share several similarities in configuration, which makes migration to GitHub Actions relatively straightforward.

CircleCI Migration CI CD

Migrating from GitLab CI/CD to GitHub Actions

Tutorial

GitHub Actions and GitLab CI/CD share several configuration similarities, which makes migrating to GitHub Actions relatively straightforward.

GitLab Migration CI CD

Migrating from Jenkins to GitHub Actions

Tutorial

GitHub Actions and Jenkins share multiple similarities, which makes migration to GitHub Actions relatively straightforward.

Jenkins Migration CI CD

Migrating from Travis CI to GitHub Actions

Tutorial

GitHub Actions and Travis CI share multiple similarities, which helps make it relatively straightforward to migrate to GitHub Actions.

Travis CI Migration CI CD

Using GitHub Actions for project management

Overview

You can use GitHub Actions to automate many of your project management tasks.

Project management

Closing inactive issues

Tutorial

You can use GitHub Actions to comment on or close issues that have been inactive for a certain period of time.

Workflows Project management

Scheduling issue creation

Tutorial

You can use GitHub Actions to create an issue on a regular basis for things like daily meetings or quarterly reviews.

Workflows Project management

Adding labels to issues

Tutorial

You can use GitHub Actions to automatically label issues.

Workflows Project management

Commenting on an issue when a label is added

Tutorial

You can use GitHub Actions to automatically comment on issues when a specific label is applied.

Workflows Project management

Moving assigned issues on project boards

Tutorial

You can use GitHub Actions to automatically move an issue to a specific column on a project board when the issue is assigned.

Workflows Project management

Removing a label when a card is added to a project board column

Tutorial

You can use GitHub Actions to automatically remove a label when an issue or pull request is added to a specific column on a project board.

Workflows Project management

Managing GitHub Actions with GitHub CLI

Overview

You can use GitHub CLI to interact with GitHub Actions.

Workflows

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.

Still need help?

Ask the GitHub community Contact support