doc: automated a record of all-time contributors

.github/CONTRIBUTING.md

@@ -13,7 +13,20 @@ These guidelines are general to all libraries published on github by the `go-ope
 
 You'll find more detailed (or repo-specific) instructions in the [maintainer's docs](../docs).
 
-## Questions & Issues
+## How can I contribute?
+
+There are many ways in which you can contribute. Here are a few ideas:
+
+ * Reporting Issues / Bugs
+ * Suggesting Improvements
+ * Code
+   * bug fixes and new features that are within the main project scope
+   * improving test coverage
+   * addressing code quality issues
+ * Documentation
+ * Art work that makes the project look great
+
+## Questions & issues
 
 ### Asking questions
 
@@ -189,49 +202,10 @@ pass it on as an open-source patch.
 We require the simple DCO below with an email signing your commit.
 PGP-signed commit are greatly appreciated but not required.
 
-The rules are pretty simple: if you can certify the below (from
-[developercertificate.org](http://developercertificate.org/)):
-
-```
-Developer Certificate of Origin
-Version 1.1
-
-Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
-660 York Street, Suite 102,
-San Francisco, CA 94110 USA
-
-Everyone is permitted to copy and distribute verbatim copies of this
-license document, but changing it is not allowed.
-
-
-Developer's Certificate of Origin 1.1
-
-By making a contribution to this project, I certify that:
-
-(a) The contribution was created in whole or in part by me and I
-    have the right to submit it under the open source license
-    indicated in the file; or
-
-(b) The contribution is based upon previous work that, to the best
-    of my knowledge, is covered under an appropriate open source
-    license and I have the right under that license to submit that
-    work with modifications, whether created in whole or in part
-    by me, under the same open source license (unless I am
-    permitted to submit under a different license), as indicated
-    in the file; or
-
-(c) The contribution was provided directly to me by some other
-    person who certified (a), (b) or (c) and I have not modified
-    it.
-
-(d) I understand and agree that this project and the contribution
-    are public and that a record of the contribution (including all
-    personal information I submit with it, including my sign-off) is
-    maintained indefinitely and may be redistributed consistent with
-    this project or the open source license(s) involved.
-```
+The rules are pretty simple:
 
-then you just add a line to every git commit message:
+* read our [DCO](./DCO.md) (from [developercertificate.org](http://developercertificate.org/))
+* if you agree with these terms, then you just add a line to every git commit message
 
     Signed-off-by: Joe Smith <[email protected]>
 

.github/DCO.md

@@ -0,0 +1,40 @@
+ # Developer's Certificate of Origin
+
+```
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+660 York Street, Suite 102,
+San Francisco, CA 94110 USA
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.
+```

.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

@@ -0,0 +1,48 @@
+name: Contributors
+
+permissions:
+  contents: read
+
+on:
+  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:
+    -
+      name: Checkout repository
+      uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+    -
+      name: Identify all-time contributors to this repository
+      uses: github/contributors@8b7586939baa0af4e801dbd22c88adf6e0db8915 # v1.7.5
+      env:
+        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        REPOSITORY:  ${{ github.repository }}
+        LINK_TO_PROFILE: 'True'
+    -
+      name: Rename contributor file
+      run: |
+        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
+        delete-branch: true
+        title: "doc: updated contributors file"
+        token: ${{ secrets.GITHUB_TOKEN }}
+        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)_