summaryrefslogtreecommitdiffhomepage
path: root/.github/workflows/git-commit-message-style.yml
diff options
context:
space:
mode:
authorLinus Färnstrand <linus@mullvad.net>2024-03-28 13:59:33 +0100
committerLinus Färnstrand <linus@mullvad.net>2024-03-28 13:59:33 +0100
commitafae8decc4a6dbb58b732af8271e8dacf5199acb (patch)
treea04a44b734362fa9cdf403087549782b31b6ab80 /.github/workflows/git-commit-message-style.yml
parent9f3cfd0932ff4ef0e74ec8b1683a40d6940be5bd (diff)
parenta1b11aa324c5357ff053c0845d01a5fbf9f9aa05 (diff)
downloadmullvadvpn-afae8decc4a6dbb58b732af8271e8dacf5199acb.tar.xz
mullvadvpn-afae8decc4a6dbb58b732af8271e8dacf5199acb.zip
Merge branch 'document-git-commit-message-workflow-better'
Diffstat (limited to '.github/workflows/git-commit-message-style.yml')
-rw-r--r--.github/workflows/git-commit-message-style.yml3
1 files changed, 3 insertions, 0 deletions
diff --git a/.github/workflows/git-commit-message-style.yml b/.github/workflows/git-commit-message-style.yml
index 2fdd56d03d..c933f1025e 100644
--- a/.github/workflows/git-commit-message-style.yml
+++ b/.github/workflows/git-commit-message-style.yml
@@ -9,6 +9,7 @@ jobs:
name: Check commit message style
runs-on: ubuntu-latest
steps:
+ # Make sure there are no whitespaces other than space, tab and newline in a commit message.
- name: Check for unicode whitespaces
uses: gsactions/commit-message-checker@v2
with:
@@ -21,6 +22,8 @@ jobs:
checkAllCommitMessages: 'true' # optional: this checks all commits associated with a pull request
accessToken: ${{ secrets.GITHUB_TOKEN }} # only required if checkAllCommitMessages is true
+ # Git commit messages should follow our guidelines. This action enforces that.
+ # Guidelines: https://github.com/mullvad/coding-guidelines/blob/main/README.md#git
- name: Check against guidelines
uses: mristin/opinionated-commit-message@f3b9cec249cabffbae7cd564542fd302cc576827 #v3.1.1
with: