Add a workflow looking for changelog fragments

Limitations:
- The comment asking for the fragment will be posted at each push on the
  PR until the fragment is present.

Closes:: #186

.github/workflows/fragment.yml

@@ -0,0 +1,18 @@
+---
+on: 
+  pull_request:
+
+name: Check changelog fragment
+jobs:
+  check_fragment:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+
+    - name: Automatic Rebase
+      run: ./hacking/check_fragment.sh
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        PR_NUMBER: ${{ github.event.number }}

README.md

@@ -182,6 +182,7 @@ See LICENCE to see the full text.
 
 Any contribution is welcome and we only ask contributors to:
 * Provide *at least* integration tests for any contribution.
+* The Pull Request *MUST* contain a changelog fragment. See [Ansible documentation](https://docs.ansible.com/ansible/latest/community/development_process.html#creating-a-changelog-fragment) about fragments.
 * Create an issue for any significant contribution that would change a large portion of the code base.
 
 ## Contributors ✨

changelogs/fragments/186_check_fragments.yml

@@ -0,0 +1,2 @@
+trivial:
+  - GH Actions now checks that all PR contains a changelog fragment.

hacking/NEED_FRAGMENT

@@ -0,0 +1,7 @@
+Dear contributor,
+
+Thank you for you Pull Request !
+To ease the work of maintainers you need to add a [changelog fragment](https://docs.ansible.com/ansible/latest/community/development_process.html#creating-a-changelog-fragment) in you PR.
+
+It will help your change be released faster !
+Thank you !

hacking/check_fragment.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+function comment() {
+    echo "No fragment detected"
+    if [ -n "$PR_NUMBER" ]; then
+        gh pr review "$PR_NUMBER" -r -F "$(git rev-parse --show-toplevel)/hacking/NEED_FRAGMENT"
+    fi
+    exit 1
+}
+
+function approve() {
+    if [ -n "$PR_NUMBER" ]; then
+        gh pr review "$PR_NUMBER" -a
+    fi
+}
+
+FRAGMENTS=$(git fetch && git diff --name-only --diff-filter=ACMRT origin/main..HEAD | grep "changelogs/fragments")
+
+if [ -z "$FRAGMENTS" ]; then
+    comment
+else
+    approve
+fi

tests/sanity/ignore-2.10.txt

@@ -1,2 +1,3 @@
 plugins/modules/grafana_dashboard.py validate-modules:invalid-argument-name
 tests/unit/modules/grafana/grafana_plugin/test_grafana_plugin.py pep8:W291
+hacking/check_fragment.sh shebang

tests/sanity/ignore-2.11.txt

@@ -1,2 +1,3 @@
 plugins/modules/grafana_dashboard.py validate-modules:invalid-argument-name
 tests/unit/modules/grafana/grafana_plugin/test_grafana_plugin.py pep8:W291
+hacking/check_fragment.sh shebang

tests/sanity/ignore-2.12.txt

@@ -1,2 +1,3 @@
 plugins/modules/grafana_dashboard.py validate-modules:invalid-argument-name
 tests/unit/modules/grafana/grafana_plugin/test_grafana_plugin.py pep8:W291
+hacking/check_fragment.sh shebang

tests/sanity/ignore-2.13.txt

@@ -1,2 +1,3 @@
 plugins/modules/grafana_dashboard.py validate-modules:invalid-argument-name
 tests/unit/modules/grafana/grafana_plugin/test_grafana_plugin.py pep8:W291
+hacking/check_fragment.sh shebang

tests/sanity/ignore-2.14.txt

@@ -1,2 +1,3 @@
 plugins/modules/grafana_dashboard.py validate-modules:invalid-argument-name
 tests/unit/modules/grafana/grafana_plugin/test_grafana_plugin.py pep8:W291
+hacking/check_fragment.sh shebang

tests/sanity/ignore-2.9.txt

@@ -1 +1,2 @@
 tests/unit/modules/grafana/grafana_plugin/test_grafana_plugin.py pep8:W291
+hacking/check_fragment.sh shebang