narukoshin/Repo Readme Stats
Dynamically generated repo stats for your README — stars, forks, languages, commits, contributors, releases, and more.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| GH_TOKEN | GitHub access token with Repo scope | yes | ${{ github.token }} |
| REPO_OWNER | Repository owner (user or org) | yes | — |
| REPO_NAME | Repository name | yes | — |
| SECTION_NAME | Name used in readme to scope the updated section | no | repo_stats |
| PULL_BRANCH_NAME | The branch to get the readme from | no | "" |
| PUSH_BRANCH_NAME | The branch to update the readme in | no | "" |
| SHOW_STARS | Show star count and growth | no | True |
| SHOW_FORKS | Show fork count | no | True |
| SHOW_LANGUAGES | Show language breakdown of the repo | no | True |
| SHOW_COMMITS | Show recent commit activity | no | True |
| SHOW_CONTRIBUTORS | Show top contributors | no | True |
| SHOW_RELEASES | Show latest release info | no | True |
| SHOW_ISSUES | Show open/closed issue counts | no | True |
| SHOW_PRS | Show open/merged PR counts | no | True |
| SHOW_CLONES | Show repo clone traffic (requires push access) | no | False |
| SHOW_TOPICS | Show repo topics | no | False |
| COMMIT_BY_ME | Git commit with your own name and email | no | False |
| COMMIT_MESSAGE | Git commit message | no | Updated with Repo Stats |
| COMMIT_USERNAME | Git commit custom username | no | "" |
| COMMIT_EMAIL | Git commit custom email | no | "" |
| COMMIT_SINGLE | Erase commit history on each commit | no | False |
| LOCALE | Show stats in your own language | no | en |
| UPDATED_DATE_FORMAT | Updated date format | no | %d/%m/%Y %H:%M:%S |
| SYMBOL_VERSION | Version of the symbol block and empty of the progress bar | no | 1 |
| BADGE_STYLE | Style for the badge maker (flat, flat-square, plastic, for-the-badge, social) | no | flat |
| FORCE_ADD | Whether to override repository .gitignore file while committing the assets | no | False |
| DEBUG_LOGGING | Whether to enable action debug logging | no | ${{ runner.debug }} |
Outputs
no outputs