stefashkaa/github-profile-crt
Generate CRT/equalizer themed GitHub contribution SVGs for profile README usage.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github-user | Target GitHub login (user or organization). Defaults to github.repository_owner. | no | ${{ github.repository_owner }} |
| github-token | GitHub token with permission to read contribution data. Defaults to github.token. | no | ${{ github.token }} |
| output-dir | Directory for generated SVG files. Defaults to `assets`. | no | assets |
| themes | Theme selector (all, comma-separated preset names, custom). Defaults to `crt`. | no | crt |
| show-grid | Toggle chart grid visibility. Defaults to `true`. | no | true |
| show-stats | Toggle dashboard widgets visibility. Defaults to `true`. | no | true |
| show-stats-footer | Toggle footer stats visibility. Defaults to `true`. | no | true |
| enable-hover-attrs | Include hover title attributes for bars. Not required for GitHub README usage. | no | false |
| include-org-private | Include private contributions from organization repositories. Defaults to `false` for privacy reasons. | no | false |
| minify-svg | Minify optimized SVG output. Defaults to `true`. | no | true |
| commit-and-push | Commit and push generated files back to the current repository branch. Defaults to `true`. | no | true |
| commit-message | Commit message used when commit-and-push is enabled. | no | chore: Update CRT contribution SVGs |
| year | Contribution year. Empty for current year (default). | no | "" |
Outputs
| name | description |
|---|---|
| output-directory | Directory where SVG files were written. |
| generated-files | Number of generated themed SVG files. |
| weeks | Number of rendered contribution weeks. |
| total-contributions | Total contributions across rendered weeks. |
| committed | Whether generated SVG changes were committed and pushed. |