GitHub Actions Workflow Syntax: on: deployment with Examples

Introduction

GitHub Actions is a robust CI/CD tool that allows developers to automate tasks within their software development lifecycle directly from their GitHub repositories. The core of this automation lies in the workflow files, which are defined using a specific syntax. In this blog post, we will explore the on: deployment event in the GitHub Actions Workflow Syntax, its usage, and provide examples.

Understanding the `on: deployment` Event

In GitHub Actions, workflows are triggered by specific events. The on: deployment event is triggered whenever a deployment is created using the GitHub Deployments API. This event can be particularly useful when you want to automate tasks whenever a deployment is created, such as running specific tests, building your application, or even deploying your application to a specific environment.

Usage of the `on: deployment` Event

The on: deployment event is defined in the workflow file right after the on keyword. Here’s a basic example of how to use the on: deployment event:

name: Deployment Workflow
on: deployment

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2
      - name: Run a one-line script
        run: echo A deployment was created!

name: Deployment Workflow

on: deployment

jobs:

build-and-deploy:

runs-on: ubuntu-latest

steps:

- name: Checkout code

uses: actions/checkout@v2

- name: Run a one-line script

run: echo A deployment was created!

In this example, the workflow is named “Deployment Workflow”. This workflow is triggered whenever a deployment is created using the GitHub Deployments API. The workflow has one job named build-and-deploy that runs on the latest version of Ubuntu. This job has two steps:

Checkout code: This step uses the actions/checkout@v2 action to checkout the repository’s code onto the runner.
Run a one-line script: This step runs a script that simply echoes a message indicating that a deployment was created.

Common Questions and Answers

Q: Can I use the on: deployment event to trigger workflows only for specific environments?

A: Yes, you can specify which environments the on: deployment event applies to using the types keyword. For example, you could specify on: deployment: types: [created] to only run the workflow when a deployment is created.

Q: Can I use the on: deployment event in conjunction with other events?

A: Yes, you can specify multiple events to trigger the workflow. For example, you could have a workflow that runs on both push and deployment events.

Conclusion

The on: deployment event in GitHub Actions Workflow Syntax is a powerful tool that allows you to automate tasks whenever a deployment is created in your repository. By understanding and effectively using this event, you can greatly enhance your automation capabilities.