Skip to content

Commit

Permalink
ci: run commitlint to check commits (#1602)
Browse files Browse the repository at this point in the history
As first step in our main "check" workflows (push, linux, mac,
windows), check all the commit messages with commitlint.

These workflows can be triggered in various ways:
pull requests, pushes, manually, or scheduled.

For (each push to) a pull request, all commits currently in the PR
branch are checked.

For a regular push, all the pushed commits are checked, usually.
Subcases: push to master, push to other branch, force push;
I think at least the first two work, I don't care to spend more time
on it.

For a manual run, it seemed to check the same commits as a push (which
push ? Not sure how this works).

For a scheduled run - we'll see.
  • Loading branch information
simonmichael committed Jul 11, 2021
1 parent f7f88a4 commit 01f9c70
Show file tree
Hide file tree
Showing 4 changed files with 64 additions and 1 deletion.
22 changes: 22 additions & 0 deletions .github/workflows/linux.yml
Expand Up @@ -87,6 +87,28 @@ jobs:
with:
fetch-depth: 0

# - name: Print debug output
# env:
# GITHUB_CONTEXT: ${{ toJson(github) }}
# run: |
# echo

# echo "$GITHUB_SHA"
# echo "$GITHUB_REF"
# echo "$GITHUB_HEAD_REF"
# echo "$GITHUB_BASE_REF"
# git log "$GITHUB_BASE_REF"..
# bin/commitlint "$GITHUB_BASE_REF"..

- name: Check commit messages
env:
BEFORE: ${{ github.event.before }}
# for a PR this will be: origin/master..origin/$GITHUB_HEAD_REF
# for a push it will be: $BEFORE..
# for a force push, BEFORE is the previous HEAD, and on github (not locally) this is an "invalid revision range"
run: |
bin/commitlint ${BEFORE:-origin/master}..${GITHUB_HEAD_REF:+origin/$GITHUB_HEAD_REF}
# things to be cached/restored:

- name: Cache stack global package db
Expand Down
9 changes: 9 additions & 0 deletions .github/workflows/mac.yml
Expand Up @@ -57,6 +57,15 @@ jobs:
with:
fetch-depth: 0

- name: Check commit messages
env:
BEFORE: ${{ github.event.before }}
# for a PR this will be: origin/master..origin/$GITHUB_HEAD_REF
# for a push it will be: $BEFORE..
# for a force push, BEFORE is the previous HEAD, and on github (not locally) this is an "invalid revision range"
run: |
bin/commitlint ${BEFORE:-origin/master}..${GITHUB_HEAD_REF:+origin/$GITHUB_HEAD_REF}
# things to be cached/restored:

- name: Cache stack global package db
Expand Down
25 changes: 24 additions & 1 deletion .github/workflows/push.yml
@@ -1,4 +1,5 @@
# Runs on notable pushes to master.
# Runs on (after) notable pushes to master.
# Failure does not block the push.

# Builds incrementally and runs functional tests on linux,
# using the latest supported GHC version.
Expand Down Expand Up @@ -50,6 +51,28 @@ jobs:
with:
fetch-depth: 0

# - name: Print debug output
# env:
# GITHUB_CONTEXT: ${{ toJson(github) }}
# run: |
# echo

# echo "$GITHUB_SHA"
# echo "$GITHUB_REF"
# echo "$GITHUB_HEAD_REF"
# echo "$GITHUB_BASE_REF"
# git log "$GITHUB_BASE_REF"..
# bin/commitlint "$GITHUB_BASE_REF"..

- name: Check commit messages
env:
BEFORE: ${{ github.event.before }}
# for a PR this will be: master..origin/$GITHUB_HEAD_REF
# for a push it will be: $BEFORE..
# for a force push, BEFORE is the previous HEAD, and on github (not locally) this is an "invalid revision range"
run: |
bin/commitlint ${BEFORE:-origin/master}..${GITHUB_HEAD_REF:+origin/$GITHUB_HEAD_REF}
# things to be cached/restored:

- name: Cache stack global package db
Expand Down
9 changes: 9 additions & 0 deletions .github/workflows/windows.yml
Expand Up @@ -47,6 +47,15 @@ jobs:
with:
fetch-depth: 0

- name: Check commit messages
env:
BEFORE: ${{ github.event.before }}
# for a PR this will be: origin/master..origin/$GITHUB_HEAD_REF
# for a push it will be: $BEFORE..
# for a force push, BEFORE is the previous HEAD, and on github (not locally) this is an "invalid revision range"
run: |
bin/commitlint ${BEFORE:-origin/master}..${GITHUB_HEAD_REF:+origin/$GITHUB_HEAD_REF}
# things to be cached/restored:

- name: Cache stack global package db
Expand Down

0 comments on commit 01f9c70

Please sign in to comment.