thisisrick25/readme-engine
A GitHub Action to dynamically update sections of your profile README with GitHub activity using a plugin-based architecture.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| GITHUB_TOKEN | The GitHub token to use for authentication. | yes | — |
| PLUGINS | A comma-separated list of plugins to run. | yes | — |
| PLUGIN_CONFIG | JSON string containing configuration for each plugin (e.g., {"prs": {"maxPrs": 5}, "notable-contributions": {"maxPrs": 10}}). | no | {} |
| COMMIT_AUTHOR_NAME | Optional. The name to attribute the automated commit to. Must be set together with COMMIT_AUTHOR_EMAIL; otherwise the commit is made by the default token identity (github-actions[bot]). | no | — |
| COMMIT_AUTHOR_EMAIL | Optional. The email to attribute the automated commit to. Must be verified on the target GitHub account for the commit to link to the user and count toward contributions. Must be set together with COMMIT_AUTHOR_NAME. | no | — |
Outputs
no outputs