narayann7/Star History Action
Render a self-updating star history chart and commit it into your README. Unofficial star-history helper action.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jul 11, 2026
- License
- None
Pinned Snippet
uses: narayann7/star-history-action@d2d4e3a948b3e05f1aef05f4576d666c97d91468 # v1.0.1tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| repos | Comma-separated owner/repo list. Defaults to the current repository. Only repos the token owns or collaborates on will work. | no | ${{ github.repository }} |
| output-dir | Directory where generated chart files (per-theme SVGs and a single PNG) are written. | no | assets/star-history |
| token | GitHub token used for the stargazers API. Defaults to the automatic Actions token. Supply a PAT secret if the default lacks access. | no | ${{ github.token }} |
| type | Chart mode: Date or Timeline. | no | Date |
| themes | Comma-separated themes to render: light, dark. | no | light,dark |
| width | Image width in pixels. | no | 800 |
| font-family | Optional Google Fonts family applied to the PNG chart (e.g. "Patrick Hand"). Empty uses the bundled Comic Neue. Affects the PNG only; GitHub strips fonts from README-embedded SVGs regardless. | no | "" |
| update-readme | Rewrite the README between the star-history marker comments to point at the newest chart. Requires the markers to exist. | no | true |
| readme | Path to the README to update when update-readme is true. | no | README.md |
| readme-format | README embed style: "picture" (SVG <picture>, GitHub dark/light) or "png" (plain-markdown absolute-URL PNG, renders on npm/pub.dev). | no | picture |
| commit | Whether to commit and push the generated files. | no | true |
| commit-message | Commit message used when committing generated files. | no | chore: update star history [skip ci] |
Outputs
| name | description |
|---|---|
| files | Newline-separated list of generated chart file paths (SVGs and the PNG). |
| changed | Whether the chart changed this run (true/false). |
| light | Path to the newest light-theme SVG (or the first theme). |
| dark | Path to the newest dark-theme SVG, if a dark theme was rendered. |
| png | Path to the generated PNG chart (single file, rendered from the first configured theme). |