doc: automated a record of all-time contributors

We want to produce a simple acknowledgement report, nothing too fancy.

Also: refactored CONTRIBUTING guidelines to refer to DCO terms.

File CONTRIBUTORS.md is updated once a week (or manually triggered).
This posts a pull request, which not auto-merged yet (there a few github
action hurdles to overcome to achieve that).

Signed-off-by: Frederic BIDON <[email protected]>

Author: fredbi

.github/workflows/auto-merge.yml

@@ -51,3 +51,24 @@ jobs:
           GH_TOKEN: ${{secrets.GITHUB_TOKEN}}
         run: gh pr merge --auto --rebase "$PR_URL"
 
+  # Auto merge is current disabled: we need automatic PRs to swap identity (e.g. using a Github App),
+  # so the pull_request event is properly captured and the PR can validate.
+  #actions-bot:
+  #  permissions:
+  #    contents: write
+  #    pull-requests: write
+  #  runs-on: ubuntu-latest
+  #  if: ${{ github.event.pull_request.user.login == 'github-actions[bot]' }}
+  #  steps:
+  #    -
+  #      name: Auto-approve all github-actions bot PRs
+  #      env:
+  #        PR_URL: ${{github.event.pull_request.html_url}}
+  #        GH_TOKEN: ${{secrets.GITHUB_TOKEN}}
+  #      run: gh pr review --approve "$PR_URL"
+  #    -
+  #      name: Auto-merge github-actions bot PRs
+  #      env:
+  #        PR_URL: ${{github.event.pull_request.html_url}}
+  #        GH_TOKEN: ${{secrets.GITHUB_TOKEN}}
+  #      run: gh pr merge --auto --rebase "$PR_URL"

.github/workflows/contributors.yml

@@ -1,16 +1,19 @@
-name: contributors
+name: Contributors
 
 permissions:
   contents: read
 
 on:
-  push:
-    branches: [ "master" ]
+  schedule:
+    - cron: '18 4 * * 6'
+
+  workflow_dispatch:
 
 jobs:
   update-contributors:
     name: all-time contributors
     permissions:
+      pull-requests: write
       contents: write
     runs-on: ubuntu-latest
     steps:
@@ -19,25 +22,27 @@ jobs:
       uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
     -
       name: Identify all-time contributors to this repository
-      id: report-contributors
       uses: github/contributors@8b7586939baa0af4e801dbd22c88adf6e0db8915 # v1.7.5
       env:
         GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         REPOSITORY:  ${{ github.repository }}
-        LINK_TO_PROFILE: "true"
+        LINK_TO_PROFILE: 'True'
     -
       name: Rename contributor file
       run: |
-        mv contributors.md EMERITUS.md
+        rm -rf contributors.json
+        mv contributors.md CONTRIBUTORS.md
     -
       name: Create a PR
+      id: create-pull-request
       uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
       with:
         commit-message: "doc: updated contributors file"
-        branch: doc/contributors-bot-${{ github.run_id}}
+        branch: doc/contributors-bot
         delete-branch: true
         title: "doc: updated contributors file"
         token: ${{ secrets.GITHUB_TOKEN }}
-        label: "bot"
+        labels: "bot"
         assignees: fredbi
         reviewers: fredbi
+        sign-commits: true

CONTRIBUTORS.md

@@ -0,0 +1,24 @@
+# Contributors
+
+- Repository: ['fredbi/jsonpointer']
+
+| Total Contributors | Total Contributions |
+| --- | --- |
+| 12  | 94  |
+
+| Username | All Time Contribution Count | All Commits |
+| --- | --- | --- |
+| @fredbi | 47 | https://github.com/fredbi/jsonpointer/commits?author=fredbi |
+| @casualjim | 33 | https://github.com/fredbi/jsonpointer/commits?author=casualjim |
+| @magodo | 3 | https://github.com/fredbi/jsonpointer/commits?author=magodo |
+| @youyuanwu | 3 | https://github.com/fredbi/jsonpointer/commits?author=youyuanwu |
+| @gaiaz-iusipov | 1 | https://github.com/fredbi/jsonpointer/commits?author=gaiaz-iusipov |
+| @gbjk | 1 | https://github.com/fredbi/jsonpointer/commits?author=gbjk |
+| @gordallott | 1 | https://github.com/fredbi/jsonpointer/commits?author=gordallott |
+| @ianlancetaylor | 1 | https://github.com/fredbi/jsonpointer/commits?author=ianlancetaylor |
+| @mfleader | 1 | https://github.com/fredbi/jsonpointer/commits?author=mfleader |
+| @Neo2308 | 1 | https://github.com/fredbi/jsonpointer/commits?author=Neo2308 |
+| @olivierlemasle | 1 | https://github.com/fredbi/jsonpointer/commits?author=olivierlemasle |
+| @testwill | 1 | https://github.com/fredbi/jsonpointer/commits?author=testwill |
+
+ _this file was generated by the [Contributors GitHub Action](https://github.com/github/contributors)_