chore(action): auto validate this repository

Author: sebastien-boulle

.github/workflows/commit-message-validator.yml

@@ -0,0 +1,20 @@
+name: 'Commit message validation on pull request'
+
+on:
+  pull_request
+
+jobs:
+  commit-message-validation:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Commit message validation
+      uses: lumapps/commit-message-validator@master
+      with:
+        no_jira: 1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -148,7 +148,7 @@ Thus we won't enforce one or the other, we will only enfore:
 
 <!-- GETTING STARTED -->
 
-## Getting Started
+## Getting Started with command line
 
 To get a local copy up and running follow these simple steps.
 
@@ -202,6 +202,36 @@ in `.git/hooks` directory of your repository.
 - if `COMMIT_VALIDATOR_NO_JIRA` environment variable is set, no validation is done on JIRA refs.
 - if `COMMIT_VALIDATOR_ALLOW_TEMP` environment variable is set, no validation is done on `fixup!` and `squash!` commits.
 
+## Getting Started with github action
+
+To enable the action simply create the .github/workflows/commit-message-validator.yml file with the following content:
+
+```yml
+name: 'Commit message validation on pull request'
+
+on:
+  pull_request
+
+jobs:
+  commit-message-validation:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Commit message validation
+      uses: lumapps/commit-message-validator@master
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+### OPTIONS
+
+- if `no_jira` is not empty, no validation is done on JIRA refs.
+- if `allow_temp` is not empty, no validation is done on `fixup!` and `squash!` commits.
+
 <!-- ROADMAP -->
 
 ## Roadmap

action.yml

@@ -0,0 +1,30 @@
+name: 'Commit message validator'
+description: 'Enforce angular commit message convention with minimal dependancy only git and bash.'
+author: 'Sébastien Boulle'
+branding:
+  icon: 'check-square'
+  color: 'green'
+inputs:
+  no_jira:
+    description: 'If not empty, no validation is done on JIRA refs.'
+    required: false
+  allow_temp:
+    description: 'If not empty, no validation is done on `fixup!` and `squash!` commits.'
+    required: false
+runs:
+  using: "composite"
+  steps:
+    - name: Ensure that base is fetched
+      run: git fetch origin ${{ github.event.pull_request.base.sha }}
+      shell: bash
+
+    - name: Ensure that head is fetched
+      run: git fetch origin ${{ github.event.pull_request.head.sha }}
+      shell: bash
+
+    - name: Validation
+      run: ${{ github.action_path }}/check.sh ${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }}
+      env:
+        no_jira: ${{ inputs.no_jira }}
+        allow_temp: ${{ inputs.allow_temp }}
+      shell: bash