Use dots in checklist - and add check (JabRef#12788)

Co-authored-by: Subhramit Basu <[email protected]>

Author: 2 people

.github/PULL_REQUEST_TEMPLATE.md

@@ -10,18 +10,18 @@ If your work is not yet complete, please open a draft pull request. In that case
 ### Mandatory checks
 
 <!--
-Go throgh the checklist below. It is mandatory, even for a draft pull request.
+Go through the checklist below. It is mandatory, even for a draft pull request.
 
-Keep ALL the items. Mark them as follows: 
+Keep ALL the items. Replace the dots inside [.] and mark them as follows: 
 [x] done 
 [ ] not done 
 [/] not applicable
 -->
 
 - [x] I own the copyright of the code submitted and I license it under the [MIT license](https://github.com/JabRef/jabref/blob/main/LICENSE)
-- [ ] Change in `CHANGELOG.md` described in a way that is understandable for the average user (if change is visible to the user)
-- [ ] Tests created for changes (if applicable)
-- [ ] Manually tested changed features in running JabRef (always required)
-- [ ] Screenshots added in PR description (if change is visible to the user)
-- [ ] [Checked developer's documentation](https://devdocs.jabref.org/): Is the information available and up to date? If not, I outlined it in this pull request.
-- [ ] [Checked documentation](https://docs.jabref.org/): Is the information available and up to date? If not, I created an issue at <https://github.com/JabRef/user-documentation/issues> or, even better, I submitted a pull request to the documentation repository.
+- [.] Change in `CHANGELOG.md` described in a way that is understandable for the average user (if change is visible to the user)
+- [.] Tests created for changes (if applicable)
+- [.] Manually tested changed features in running JabRef (always required)
+- [.] Screenshots added in PR description (if change is visible to the user)
+- [.] [Checked developer's documentation](https://devdocs.jabref.org/): Is the information available and up to date? If not, I outlined it in this pull request.
+- [.] [Checked documentation](https://docs.jabref.org/): Is the information available and up to date? If not, I created an issue at <https://github.com/JabRef/user-documentation/issues> or, even better, I submitted a pull request to the documentation repository.

.github/ghprcomment.yml

@@ -1,3 +1,6 @@
+- jobName: 'PR checklist OK'
+  messsage:
+    Note that your PR will not be accepted/reviewed until you have gone through the mandatory checks in the description, or have removed them.
 - jobName: 'Source branch is other than "main"'
   message: >
     You committed your code on `main` brach. This is bad practise.

.github/workflows/tests.yml

@@ -356,6 +356,57 @@ jobs:
           show-progress: 'false'
       - uses: gradle/actions/wrapper-validation@v4
 
+  checklist-checked:
+    if: github.actor != 'dependabot[bot]' && github.event_name == 'pull_request'
+    name: PR checklist OK
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v4
+        with:
+          submodules: 'false'
+          show-progress: 'false'
+      - name: Check for PR checklist
+        id: check_changelog_modification
+        run: |
+          set -e
+
+          BODY=$(gh pr view "${{ github.event.number }}" --json body --template '{{.body}}' | grep -A5000 '### Mandatory checks')
+          echo "Found body: $BODY"
+
+          # Ensure the section exists
+          if ! printf '%s\n' "$BODY" | grep -q "### Mandatory checks"; then
+              echo "❌ '### Mandatory checks' section is missing!"
+              exit 1
+          fi
+
+          BOXES=$(printf '%s\n' "$BODY" | grep "^- \[")
+          echo "Found boxes: $BOXES"
+
+          # Ensure at least one checkbox exists
+          if [ -z "$BOXES" ]; then
+              echo "❌ No checkboxes found in '### Mandatory checks'!"
+              exit 1
+          fi
+
+          while IFS= read -r line; do
+              if ! printf '%s\n' "$line" | grep -Eq "^- \[(x|/| )\] "; then
+                  echo "❌ Found improperly formatted checkbox: '$line'"
+                  exit 1
+              fi
+          done <<< "$BOXES"
+
+          LINE_COUNT=$(echo "$BOXES" | wc -l)
+
+          if [ "$LINE_COUNT" -ne 7 ]; then
+            echo "❌ $LINE_COUNT instead of 7 lines"
+            exit 1
+          fi
+
+          echo "✅ All checkboxes are in the correct format."
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
   # This ensures that no git merge conflict markers (<<<, ...) are contained
   merge_conflict_job:
     name: Find merge conflicts