jimschubert/Beast Changelog
Generate a social-first markdown changelog using GitHub APIs
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| GITHUB_TOKEN | GitHub token used to access the repository defined in the GITHUB_REPOSITORY input. It is recommended to [create a new personal access token](https://github.com/settings/tokens/new) with the least permissions (e.g. public_repo). Using a service account for the GitHub Token is also highly recommended. [Learn more about using secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) | yes | ${{github.token}} |
| GITHUB_REPOSITORY | The target github repo in the format owner/repo | yes | ${{github.repository}} |
| CONFIG_LOCATION | The file location to the changelog configuration. See [jimschubert/changelog](https://github.com/jimschubert/changelog) for schema and further details. | yes | .github/changelog.json |
| OUTPUT | The output file where the changelog will be written. The file is created and appended, but _not_ committed back to the repository. It is recommended to add a post-processing step in your workflow to prepend to an existing changelog. | yes | .github/CHANGELOG.md |
| FROM | The beginning tag from which to generate the changelog. This can be queried on an unshallow-ed repository with: ``` git describe --tags --abbrev=0 --match 'v*' HEAD~ ``` See also [jimschubert/query-tag-action](https://github.com/jimschubert/query-tag-action). | yes | — |
| TO | The ending tag until which the changelog should be generated. This can be queried on an unshallow-ed repository with: ``` git describe --tags --abbrev=0 --match 'v*' HEAD ``` See also [jimschubert/query-tag-action](https://github.com/jimschubert/query-tag-action). | yes | — |
Outputs
no outputs