ardalanamini/Auto Changelog

Automatic Changelog generator

Trust Signals

name	description	required	default
preferred-api	The preferred API to acquire the required information to generate the changelog	yes	GitHub
github-token	Github token	yes	${{ github.token }}
commit-types	Commit types	yes	feat: New Features fix: Bug Fixes build: Build System & Dependencies perf: Performance Improvements docs: Documentation test: Tests refactor: Refactors chore: Chores ci: CI style: Code Style revert: Reverts
default-commit-type	Default commit type to be used when the commit message matches none of the defined types	yes	Other Changes
release-name	Release name (version)	yes	${{ github.ref_name }}
monorepo-detectors	Monorepo detection strategies used for package release tags. One or more of auto, pnpm, npm, yarn, lerna, nx.	no	auto
include-root-commits	Include root-level commits in package changelogs. One of false, auto, all.	no	false
release-name-prefix	Release name (version) prefix	no	""
mention-authors	Mention the author of each commit	yes	true
mention-new-contributors	Mention new contributors at the bottom of the changelog (New Contributors)	yes	true
include-compare-link	Include GitHub compare at the bottom of the changelog (Full Changelog)	yes	true
include-pr-links	Include GitHub pull request links at each log if applicable	yes	true
include-commit-links	Include GitHub commit links at each log	yes	true
semver	Enable semver based version comparison	yes	true
use-github-autolink	Use GitHub Autolink	yes	true

name	description
changelog	The generated changelogs
prerelease	Indicates whether it's a pre-release or not (if semver is set to true, otherwise this output will always return false)
release-id	The pre-release id in case of prerelease being true, latest otherwise (if semver is set to true, otherwise this output will always return latest)
package-name	The selected monorepo package name when a package release tag is detected
package-path	The selected monorepo package path when a package release tag is detected