Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/koppor/github-contributors-list
Outputs all the contributors for given open GitHub project
https://github.com/koppor/github-contributors-list
acknowledgements all-contributors contributors github github-page open-source-tooling opensource recognition
Last synced: about 2 months ago
JSON representation
Outputs all the contributors for given open GitHub project
- Host: GitHub
- URL: https://github.com/koppor/github-contributors-list
- Owner: koppor
- License: mit
- Created: 2024-04-02T14:17:21.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-10-16T12:00:37.000Z (2 months ago)
- Last Synced: 2024-10-19T04:02:24.580Z (2 months ago)
- Topics: acknowledgements, all-contributors, contributors, github, github-page, open-source-tooling, opensource, recognition
- Language: Java
- Homepage:
- Size: 94.7 KB
- Stars: 11
- Watchers: 2
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Contributors List
Builds a contributor list based on information available on GitHub.
It reads the information of pull requests including the `Co-authored-by:` notes in commit messages.
GitHub's API [does NOT include users listed as "Co-authored-by:"](https://github.com/orgs/community/discussions/46421).
Thefore, the commit messages need to parsed "manually".
It is a rewrite of [github-contributors-list](https://github.com/mgechev/github-contributors-list) to [support `Co-authored-by:`](https://github.com/mgechev/github-contributors-list/issues/26).
## Example
See for real-world usage.
## How to use
1. [Install jbang](https://www.jbang.dev/documentation/guide/latest/installation.html#using-jbang).
E.g.,
- Linux/macOS: `curl -Ls https://sh.jbang.dev | bash -s - app setup` or
- Windows (Powershell): `iex "& { $(iwr -useb https://ps.jbang.dev) } app setup"`
2. Add `oauth=...` to `~/.github` with `...` being your [GitHub personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic). See [GitHub API for Java](https://github-api.kohsuke.org/) for details.
3. `cd` to the repository you want to analyze.
4. `jbang gcl@koppor/github-contributors-list`
```terminal
Usage: jbang gcl@koppor/github-contributors-list [-lhV] [--startrevision=]
[--endrevision=] [--repository=]
[--cols=] [--filter=]...
[--filter-emails=]... [-m=]...
[]
[] The path to the git repository to analyse.
--cols= Number of columns
--endrevision=
The last revision to check (tag or commit id).
Included.
--filter=
--filter-emails=
-h, --help Show this help message and exit.
-l, --[no-]github-lookup Should calls be made to GitHub's API for user
information
-m, --login-mapping=
Mapping of GitHub logins to names. Format:
name=login
--repository=
The GitHub repository in the form
owner/repostiory. E.g., JabRef/jabref
--startrevision=
The first revision to check (tag or commit id).
Excluded.
-V, --version Print version information and exit.
```
Example:
```terminal
Usage: jbang gcl@koppor/github-contributors-list --repository JabRef/jabref c:\git-repositories\jabref --startrevision=v5.13 --endrevision=v5.15
```
At the end, non-found committers are listed.
The format is ` `.
Example:
```text
Anish.Pal https://github.com/JabRef/jabref/pull/10829 https://github.com/JabRef/jabref/pull/10829/commits/d2d84923df2c6c7d59559da8d583ae17dc803c3d
```
With that information, one can create a mapping from the committer name to the GitHub username.
In this case: `Anish.Pal=pal-anish`
The tool is implemented as single pass over the commits of the repository.
It uses a cache to store the information of contributors.
Thus, repeated runs could update contributor information.
For instance, if a user first appears as "Co-authored-by:" and later as a pull request author, the username could be determined better.
In case of issues, try to delete `gcl.mv` to start with a fresh cache.
## FAQ
⚠ In case contributors are not ignored, please delete `gcl.mv` and try again. ⚠
## Implementation details
- `gcl.mv` is an [MVStore](https://www.h2database.com/html/mvstore.html) caching contributor information returned by GitHub's API.
- Dependencies of `gcl.java` cannot be updated automatically. [dependabot-core#9406](https://github.com/dependabot/dependabot-core/issues/9406).
- Use `writer.level = TRACE` in tinylog.properties for debugging.
## Alternatives
- Manually curate all contributors using [All Contributors](https://allcontributors.org/)
- Use [github-contributors-list](https://github.com/mgechev/github-contributors-list) and accept that `Co-authored-by:` is ignored.