actions-marketplace-validations/Generate changelog
Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Maintainedlast commit Oct 9, 2025
- License
- MIT
Pinned Snippet
uses: actions-marketplace-validations/heinrichreimer_action-github-changelog-generator@0921fc012fc58149561ebea6f9af3c00d737b408 # no releases — HEAD as of 2026-07-13tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| repo | Target GitHub repo in the form of organization/repository. | no | — |
| user | Username of the owner of target GitHub repo. | no | — |
| project | Name of project on GitHub. | no | — |
| token | To make more than 50 requests per hour your GitHub token is required. | no | — |
| dateFormat | Date format. | no | — |
| output | Output file. | no | — |
| base | Optional base file to append generated changes to. | no | — |
| headerLabel | Set up custom header label. | no | — |
| configureSections | Define your own set of sections which overrides all default sections. | no | — |
| addSections | Add new sections but keep the default sections. | no | — |
| frontMatter | Add YAML front matter. Formatted as JSON because it's easier to add on the command line. | no | — |
| issues | Include closed issues in changelog. | no | — |
| issuesWoLabels | Include closed issues without labels in changelog. | no | — |
| pullRequests | Include pull-requests in changelog. | no | — |
| prWoLabels | Include pull requests without labels in changelog. | no | — |
| filterByMilestone | Use milestone to detect when issue was resolved. | no | — |
| author | Add author of pull request at the end. | no | — |
| usernamesAsGithubLogins | Use GitHub tags instead of Markdown links for the author of an issue or pull-request. | no | — |
| unreleasedOnly | Generate log from unreleased closed issues only. | no | — |
| unreleased | Add to log unreleased closed issues. | no | — |
| unreleasedLabel | Set up custom label for unreleased closed issues section. | no | — |
| compareLink | Include compare link (Full Changelog) between older version and newer version. | no | — |
| includeLabels | Of the labeled issues, only include the ones with the specified labels. | no | — |
| excludeLabels | Issues with the specified labels will be excluded from changelog. | no | — |
| issueLineLabels | The specified labels will be shown in brackets next to each matching issue. Use "ALL" to show all labels. | no | — |
| excludeTags | Changelog will exclude specified tags. | no | — |
| excludeTagsRegex | Apply a regular expression on tag names so that they can be excluded. | no | — |
| sinceTag | Changelog will start after specified tag. | no | — |
| dueTag | Changelog will end before specified tag. | no | — |
| maxIssues | Maximum number of issues to fetch from GitHub. | no | — |
| releaseUrl | The URL to point to for release links, in printf format (with the tag as variable). | no | — |
| githubSite | The Enterprise GitHub site where your project is hosted. | no | — |
| githubApi | The enterprise endpoint to use for your GitHub API. | no | — |
| simpleList | Create a simple list from issues and pull requests. | no | — |
| futureRelease | Put the unreleased changes in the specified release number. | no | — |
| releaseBranch | Limit pull requests to the release branch, such as master or release. | no | — |
| httpCache | Use HTTP Cache to cache GitHub API requests (useful for large repos). | no | — |
| cacheFile | Filename to use for cache. | no | — |
| cacheLog | Filename to use for cache log. | no | — |
| sslCaFile | Path to cacert.pem file. | no | — |
| verbose | Run verbosely. | no | — |
| breakingLabel | Set up custom label for breaking changes section. | no | — |
| breakingLabels | Issues with these labels will be added to a new section, called "Breaking changes". | no | — |
| enhancementLabel | Set up custom label for enhancements section. | no | — |
| enhancementLabels | Issues with the specified labels will be added to "Implemented enhancements" section. | no | — |
| bugsLabel | Set up custom label for bug-fixes section. | no | — |
| bugLabels | Issues with the specified labels will be added to "Fixed bugs" section. | no | — |
| deprecatedLabel | Set up custom label for deprecated section. | no | — |
| deprecatedLabels | Issues with the specified labels will be added to a section called "Deprecated". | no | — |
| removedLabel | Set up custom label for removed section. | no | — |
| removedLabels | Issues with the specified labels will be added to a section called "Removed". | no | — |
| securityLabel | Set up custom label for security section. | no | — |
| securityLabels | Issues with the specified labels will be added to a section called "Security fixes". | no | — |
| issuesLabel | Set up custom label for closed-issues section. | no | — |
| prLabel | Set up custom label for pull requests section. | no | — |
| onlyLastTag | Changelog will only show last tag. | no | — |
| stripHeaders | Strip headers. | no | — |
| stripGeneratorNotice | Strip generator reference. | no | — |
Outputs
| name | description |
|---|---|
| changelog | Contents of generated change log. |