This tiny package scans and generates a markdown command-separated list of GitHub users contributed to a repo including issue reporters, PR creators, reviewers, and all commenters.
Notes:
- This package only counts closed issues and PRs.
- This only works with GitHub repositories.
Run this command in the root directory of a GitHub repository.
~/workspace/wpcs-action
% npx github:10up/credits-generator
[Tung Du (@dinhtungdu)](https://github.com/dinhtungdu), [Jeffrey Paul (@jeffpaul)](https://github.com/jeffpaul)-
--pat(optional)GitHub Personal Access Token (PAT). Due to the rate limit of unauthorized API access, we may need PAT to ensure GitHub doesn't block our requests. Personal Access Token can be created here, no scope is required.
-
--since(optional)A string value representing a date, specified in a format recognized by the
Date.parse()method. By default, contributions are counted from the beginning. When this is set, only contributions after the given date will be queried. -
--no-fullName(optional)By default, the generated markdown includes the name of contributors. Passing this flag to only return the contributors' username. This reduces dramatically the number of API requests for the generation because we have to retrieve the name for each contributor in a separate request.
-
--exclude(optional)A comma-spearated string of GitHub username to exclude from the final result.
Beta: This project is quite new and we're not sure what our ongoing support level for this will be. Bug reports, feature requests, questions, and pull requests are welcome. If you like this project please let us know, but be cautious using this in a Production environment!
A complete listing of all notable changes to Credits Generator are documented in CHANGELOG.md.
Please read CODE_OF_CONDUCT.md for details on our code of conduct, CONTRIBUTING.md for details on the process for submitting pull requests to us, and CREDITS.md for a list of maintainers, contributors, and libraries used in this repository.
