ci: Conventional Commits (#8)

* ci: add commitlint

* docs: update README.md

.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.7, 3.8, 3.9]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install tox
+    - name: Run tox
+      run: tox
+
+  commitlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Install required dependencies
+        run: |
+          sudo apt install -y git curl
+          curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash -
+          sudo DEBIAN_FRONTEND=noninteractive apt install -y nodejs
+
+      - name: Install commitlint
+        run: |
+          npm install @commitlint/config-conventional
+
+      - name: Validate current commit (last commit) with commitlint
+        if: github.event_name == 'push'
+        run: npx commitlint --from HEAD~1 --to HEAD --verbose
+
+      - name: Validate PR commits with commitlint
+        if: github.event_name == 'pull_request'
+        run: npx commitlint --from ${{ github.event.pull_request.head.sha }}~${{ github.event.pull_request.commits }} --to ${{ github.event.pull_request.head.sha }} --verbose

CONTRIBUTING.md

@@ -4,6 +4,8 @@
 
 **unit and functionals tests** are mandatory.
 
+Please use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary).
+
 Please ensure you have run the following before pushing a commit:
   * `black` and `isort` (or `invoke reformat`)
   * `tox` to run all linters

README.md

@@ -1,5 +1,9 @@
 # SONiC Saltstack modules
 
+> This repository is part of [AFK](https://criteo.github.io/AFK).
+
+The full documentation can be found here: [AFK documentation](https://criteo.github.io/AFK/SONiC-support/SONiC-modules/)
+
 ## Current supported versions
 
 * 201911
@@ -33,3 +37,7 @@ sonic_commit_id: some-commit-id
 ```
 
 This is automatically set by our [SONiC Salt Deployer](https://github.com/criteo/sonic-salt-deployer).
+
+## How to contribute
+
+see [CONTRIBUTING.md](CONTRIBUTING.md)

commitlint.config.js

@@ -0,0 +1 @@
+module.exports = {extends: ['@commitlint/config-conventional']}