New GitHub workflow to auto-update list of contributors #6

MrChocolatine · 2021-11-05T13:37:07Z

New GitHub workflow to auto-update the list of contributors (#6)

When this workflow runs it does:

Update the list of contributors
- By directly pushing a commit on the default branch
- Or, if the default branch is protected, by creating a pull request
If there was already a previous PR
This is not executed if the update was made through a commit
1. A link to the new PR is posted on the previous PR
2. And the previous PR is closed

For more details, checkout https://github.com/akhilmhdh/contributors-readme-action .

Input that can be passed from the caller workflow:

use_username (optional)
If contributors should be listed with their username instead of their full name.

Currently implemented in the repositories

Notes

GitHub CLI gh is preinstalled on all GitHub-hosted runners
https://docs.github.com/en/actions/advanced-guides/using-github-cli-in-workflows

See all included tools for each runner operating system:
https://github.com/actions/virtual-environments/tree/main/images

For instance, the runner Ubuntu 20.04.3 LTS.
GitHub REST API
https://docs.github.com/en/rest
GitHub CLI manual
https://cli.github.com/manual

MrChocolatine · 2021-11-05T16:51:10Z

.github/workflows/auto-update-contributors-readme.yml

+        with:
+          commit_message: 'chore: auto-update contributors list (GH Action)'
+          committer_username: 'akhilmhdh/contributors-readme-action'
+          is_protected: ${{ steps.default_branch.outputs.is_protected == 'true' }}


Passing is_protected might not be needed in the future:
akhilmhdh/contributors-readme-action#37

Not needed anymore!

MrChocolatine · 2021-11-05T16:51:28Z

.github/workflows/auto-update-contributors-readme.yml

+      - name: Check if the default branch is protected
+        id: default_branch
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          defaultBranch="$( gh api /repos/${{ github.repository }} \
+            --method GET \
+            --jq '.default_branch'
+          )"
+
+          isProtected="$( \
+            gh api /repos/${{ github.repository }}/branches/$defaultBranch \
+            --jq '.protected'
+          )"
+
+          echo "::set-output name=is_protected::$isProtected"


This block might not be needed in the future:
akhilmhdh/contributors-readme-action#37

All removed!

MrChocolatine · 2021-11-05T17:05:30Z

.github/workflows/auto-update-contributors-readme.yml

+            gh api search/issues \
+              --method GET \
+              --raw-field q='repo:${{ github.repository }} type:pr state:open "Auto-update list of contributors" in:title' \
+              --jq '.items.[0].number' \


https://cli.github.com/manual/gh_api

https://docs.github.com/en/rest/reference/search#search-issues-and-pull-requests

Regarding the filter query:

q='repo:${{ github.repository }} type:pr state:open "Auto-update list of contributors" in:title'

It is easy to try to build such a query via GitHub, and values do not need to be escaped, for instance:
https://github.com/pulls?q=repo:peopledoc/ember-cli-embedded%20type:pr%20state:closed%20%22release%22%20in:title

Plus, I could not find a better query to ensure to get the right pull request. Filtering on the title seems to be the most reliable way 🤔 . I could eventually add a filter on the author app/github-actions.

Filter on author added.

MrChocolatine · 2021-11-08T15:45:27Z

.github/workflows/auto-update-contributors-readme.yml

+      # The Action `akhilmhdh/contributors-readme-action` creates PRs with a fixed title:
+      # https://github.com/akhilmhdh/contributors-readme-action/blob/v2.3/src/index.js#L169
+      - name: Rename the new PR with a better title
+        if: ${{ steps.default_branch.outputs.is_protected == 'true' }}
+        id: rename_new_pr
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          sleep 10 # Some delay is needed to make sure GitHub had time to create the new PR
+
+          ID_PR="$( \
+            gh api search/issues \
+              --method GET \
+              --raw-field q='repo:${{ github.repository }} type:pr state:open "contributors readme action update" in:title' \
+              --jq '.items.[0].number' \
+          )"
+
+          gh pr edit $ID_PR \
+            --repo ${{ github.repository }} \
+            --title "Auto-update list of contributors"
+
+          echo "::set-output name=id_new_pr::$ID_PR"


This whole step may not be needed in the future:
akhilmhdh/contributors-readme-action#35

Instead we will be able to do pass an input to the step responsible for creating the PR:

- uses: akhilmhdh/[email protected] with: pr_title: My Custom Title

Plus, the GitHub Action akhilmhdh/contributors-readme-action may be able to output the ID of the PR that was created.

All removed!

Thanks to the new version `akhilmhdh/[email protected]`.

Mentioning `readme` in the filename does not really make since we can make the GitHub Action updates another file, see: https://github.com/akhilmhdh/contributors-readme-action/blob/v2.3.2/.github/workflows/main.yml#L16-L17

MrChocolatine force-pushed the add-workflow-auto-update-list-contributors branch 4 times, most recently from 5039c39 to b6bcf89 Compare November 5, 2021 15:51

MrChocolatine commented Nov 5, 2021

View reviewed changes

MrChocolatine added 2 commits November 5, 2021 16:57

add wf to auto-update contributors list in README

89ac8c9

auto-detect if default branch is protected

2feab9d

MrChocolatine force-pushed the add-workflow-auto-update-list-contributors branch from b6bcf89 to 2feab9d Compare November 5, 2021 16:58

MrChocolatine commented Nov 5, 2021

View reviewed changes

MrChocolatine commented Nov 8, 2021

View reviewed changes

MrChocolatine force-pushed the add-workflow-auto-update-list-contributors branch 19 times, most recently from 6d7ff58 to df983a3 Compare November 8, 2021 17:31

MrChocolatine force-pushed the add-workflow-auto-update-list-contributors branch 8 times, most recently from 12a6c3d to d85220d Compare November 8, 2021 22:13

MrChocolatine added 2 commits November 8, 2021 22:14

over simplify logic

d30bd5c

Thanks to the new version `akhilmhdh/[email protected]`.

accept input use_username

fb09116

MrChocolatine force-pushed the add-workflow-auto-update-list-contributors branch from d85220d to fb09116 Compare November 8, 2021 22:15

MrChocolatine changed the title ~~add workflow auto update list contributors~~ New GitHub workflow to auto-update list of contributors Nov 9, 2021

MrChocolatine marked this pull request as ready for review November 9, 2021 08:57

filter PR on author to make query more precise

2ef95ff

MrChocolatine force-pushed the add-workflow-auto-update-list-contributors branch from 98ba0e6 to 2ef95ff Compare November 9, 2021 09:20

split query over multiple lines

999b062

MrChocolatine force-pushed the add-workflow-auto-update-list-contributors branch from 23b9969 to 999b062 Compare November 9, 2021 09:33

rename workflow file

365bbe2

Mentioning `readme` in the filename does not really make since we can make the GitHub Action updates another file, see: https://github.com/akhilmhdh/contributors-readme-action/blob/v2.3.2/.github/workflows/main.yml#L16-L17

MrChocolatine force-pushed the add-workflow-auto-update-list-contributors branch from 56d2a3e to 365bbe2 Compare November 9, 2021 10:28

GreatWizard approved these changes Nov 9, 2021

View reviewed changes

MrChocolatine merged commit 51b71a1 into main Nov 9, 2021

MrChocolatine deleted the add-workflow-auto-update-list-contributors branch November 9, 2021 15:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New GitHub workflow to auto-update list of contributors #6

New GitHub workflow to auto-update list of contributors #6

MrChocolatine commented Nov 5, 2021 •

edited

Loading

MrChocolatine Nov 5, 2021

MrChocolatine Nov 8, 2021

MrChocolatine Nov 5, 2021

MrChocolatine Nov 8, 2021

MrChocolatine Nov 5, 2021

MrChocolatine Nov 5, 2021

MrChocolatine Nov 9, 2021

MrChocolatine Nov 8, 2021

MrChocolatine Nov 8, 2021

New GitHub workflow to auto-update list of contributors #6

New GitHub workflow to auto-update list of contributors #6

Conversation

MrChocolatine commented Nov 5, 2021 • edited Loading

New GitHub workflow to auto-update the list of contributors (#6)

Currently implemented in the repositories

Notes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MrChocolatine commented Nov 5, 2021 •

edited

Loading