Skip to content

Run github action locally

GitHub Actions help automate tasks like building, testing, and deploying in your GitHub repository. With act CLI tool we can write and test the GitHub action locally.

1
curl https://raw.githubusercontent.com/nektos/act/master/install.sh | sudo bash

config github action

  • Add .github/workflows folder to project root
  • Add yaml file and declare jobs

view

from project root

1
act -l

example

Run job on local docker

1
act -j build_demo -P name=docker_image --pull=false
arg desc
-j job to run for workflow
-P custom image to
--pull pull image from hub or find it locally

Workflow

1
2
3
4
5
6
7
8
name: My Action
on: [workflow_dispatch]
jobs:
  build_demo:
    runs-on: rome_arm
    steps:
      - name: Hello, World!
        run: echo "build job hello world"
arg desc
name workflow name
on running trigger event [push, pull_request, workflow_dispatch]
jobs workflow jobs
runs-on platform to run on (image name declare in act command )

multiple lines

use | to mark multiple lines

1
2
3
4
5
steps:
  - name: colcon
    run: | 
        line 1
        line 2

Reference