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

Add contributor list #3317

Merged
merged 10 commits into from
Oct 6, 2024
Merged

Add contributor list #3317

merged 10 commits into from
Oct 6, 2024

Conversation

caco3
Copy link
Collaborator

@caco3 caco3 commented Oct 6, 2024

Implements: #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

Initially provided by Ayushjhawar8

Ayushjhawar8 and others added 10 commits October 6, 2024 23:15
* 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>
@caco3 caco3 merged commit 32eb583 into main Oct 6, 2024
0 of 14 checks passed
@SybexX
Copy link
Collaborator

SybexX commented Oct 6, 2024

@caco3 For me it only shows this:
Unbenannt

@caco3
Copy link
Collaborator Author

caco3 commented Oct 6, 2024

Thats on purpose, I only want to run it on a release, thus it is coming with v16.0.0.

How ever on my tests I get odd errors and am unable to solve them yet: https://github.com/caco3/AI-on-the-edge-device/actions/runs/11205745235/job/31145613615
It seems only to work if run in a branch (and not on a tag/release)
I might need to remove it again for now :(

Followup: akhilmhdh/contributors-readme-action#81

@caco3 caco3 deleted the add-contributor-list branch October 18, 2024 11:25
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.

3 participants