warrenbrasil/Release Changelog Builder
A GitHub action that builds your release notes / changelog fast, easy and exactly the way you want.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| configuration | Defines the relative path to the configuration file. | — | — |
| path | Defines the directory the repo is located in (checkout directory) | — | — |
| owner | Defines the owner of the repository to create the changelog for | — | — |
| repo | Defines the repository to create the changelog for | — | — |
| fromTag | Defines the previous tag to compare against | — | — |
| toTag | Defines the newly tag created | — | — |
| includeOpen | Defines if the changelog should include open PRs | — | false |
| ignorePreReleases | Defines if the action will only use full releases to compare against (Only used if fromTag is not defined). E.g. for 1.0.1... 1.0.0-rc02 <- ignore, 1.0.0 <- pick | — | false |
| failOnError | Defines if the action should result in a build failure, if an error was discovered | — | false |
| fetchReviewers | Will enable fetching the users/reviewers who approved the PR | — | false |
| commitMode | Enables a `light` commit based mode. This mode generates changelogs based on the commits. Please note that this is not officially supported, and lacks a lot of features only possible with PRs. | — | false |
| outputFile | If defined, the changelog will get written to this file. (relative to the checkout dir) | — | — |
| token | Defines the token to use to execute the git API requests with, uses `env.GITHUB_TOKEN` by default | — | — |
| baseUrl | Defines the base url for GitHub Enterprise authentication, uses `https://api.github.com` by default | — | — |
Outputs
| name | description |
|---|---|
| changelog | The built release changelog built from the merged pull requests |
| pull_requests | A comma seperated list of PR numbers that were merged |
| owner | Specifies the owner of the repository processed |
| repo | Describes the repository name, which was processed |
| fromTag | Defines the `fromTag` which describes the lower bound to process pull requests for |
| toTag | Defines the `toTag` which describes the upper bound to process pull request for |
| failed | Defines if there was an issue with the action run, and the changelog may not have been generated correctly. [true, false] |
| categorized_prs | Count of categorized pull requests |
| uncategorized_prs | Count of uncategorized pull requests |
| open_prs | Count of open pull requests. Only fetched if `includeOpen` is enabled. |