Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: #3310 Automatically Update Contributor List with github actions #3312

Merged
merged 6 commits into from
Oct 6, 2024

Conversation

Ayushjhawar8
Copy link
Contributor

Fixes: #3310

Overview

This pull request introduces a GitHub Action workflow that automatically updates the contributor names in the README file whenever a new commit is pushed to the main branch.

Changes Made

  • GitHub Action Workflow: A new workflow file named main.yml has been added under .github/workflows/.
  • Contributor List Update: The workflow retrieves unique contributor names from the git log and appends them to the README.md file under a new "Contributors" section. Here is the relevant section of the code:

Screenshot

image

@Ayushjhawar8
Copy link
Contributor Author

so you see the github action automatically create and update data of the table inside readme file whenever someone pushes onto main

@caco3
Copy link
Collaborator

caco3 commented Oct 6, 2024

Thanks, looks nice and automatic.

Just one question:
Basically what it does is on every commit it adds another commit.
This clutters the history and also means that one has to run git pull after every push + action run:
image

Thus I would suggest to only run on a release. This is possible when you add it to https://github.com/jomjol/AI-on-the-edge-device/blob/main/.github/workflows/build.yaml#L274 instead to the main.yml

Also, can you add a comment above <!-- readme: contributors -start --> with something like <!-- Autogenerated, do not manually update, see https://github.com/marketplace/actions/contribute-list -->

@caco3 caco3 changed the base branch from main to add-contributor-list October 6, 2024 20:57
@caco3 caco3 changed the base branch from add-contributor-list to main October 6, 2024 20:57
@caco3 caco3 changed the base branch from main to add-contributor-list October 6, 2024 21:15
@caco3 caco3 merged commit ecf5927 into jomjol:add-contributor-list Oct 6, 2024
caco3 added a commit that referenced this pull request Oct 6, 2024
* feat: #3310 Automatically Update Contributor List  (#3312)

* Create main.yml

* Update README.md

* docs(contributor): contrib-readme-action has updated readme

* Update main.yml

* docs(contributor): contrib-readme-action has updated readme

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update build.yaml

* docs(contributor): contrib-readme-action has updated readme

* Delete .github/workflows/main.yml

* Update README.md

* docs(contributor): contrib-readme-action has updated readme

* Update README.md

* docs(contributor): contrib-readme-action has updated readme

* Update build.yaml

* Update README.md

---------

Co-authored-by: Ayush Jhawar <111112495+Ayushjhawar8@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@caco3
Copy link
Collaborator

caco3 commented Oct 6, 2024

I adapted my change requests directly in #3317

Thanks for your contribution!

@Ayushjhawar8 Ayushjhawar8 changed the title feat: #3310 Automatically Update Contributor List feat: #3310 Automatically Update Contributor List with github actions Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add contributors name in readme
2 participants