Set up GitHub Actions
https://docs.github.com/en/actions/quickstart
-
Create the necessary directories in your project
mkdir -p .github/workflows
-
Create the new workflow file
touch .github/workflows/ci.yml
-
Populate the workflow file with one of the starter workflows
-
The starter workflows are here: https://github.com/actions/starter-workflows. See here for CI starter workflows in particular: https://github.com/actions/starter-workflows/tree/main/ci
-
When copying the starter workflow, replace
$default-branch
withmain
ormaster
as appropriate ($default-branch
is only for workflow templates)
-
-
(Optional) Create a badge in your readme
Follow this pattern:
[](https://github.com/USER/REPOSITORY/actions)
- Replace
USER
andREPOSITORY
as necessary - Replace
WORKFLOW_NAME
with the exact value you used forname
in the workflow file, e.g.CI
- Note that this is case-sensitive
e.g.
[](https://github.com/bmaupin/devops-cheatsheets/actions)
- Replace
Skip CI
Add [skip ci]
to the commit message
Jobs
Run an executable file in the repo
Prefix it with ./
, e.g.
- name: Build
run: ./build.sh
Run multiple commands in a step
Use a pipe, e.g.
run: |
wget https://github.com/IDPF/epubcheck/releases/download/v${EPUBCHECK_VERSION}/epubcheck-${EPUBCHECK_VERSION}.zip
unzip epubcheck-${EPUBCHECK_VERSION}.zip