glitch452/Branch Release

Automation for releasing a package where the dist files need to be published to another branch.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
github-tokenA github token with access to write to the repository.yes
build-commandThe command to build the dist files for the project (ex. npm run build)
changelog-titlesA JSON encoded object, mapping the conventional commit type to the section title to use in the changelog for that type. These values will be merged into and override the default titles. (ex. `{ "feat": "New Features" }`)
disable-git-taggingDisable setting and/or updating the git tags.false
disable-github-releaseCreate a GitHub Release.false
dry-runRun the action without actually releasing the package or pushing git tags.false
get-release-title-from-prAttempt to get the PR title from a PR associated to the git sha. If it is found, use the PR title as the release title. If not found, fall back to the release tag name. If the `release-title` has a truthy value, it will override this option. Note: The GITHUB_TOKEN requires `pull-requests: read` permissions.false
git-tag-suffixA value append to the git tags.
latest-tag-nameThe tag used to track the latest commit on the release branch.latest
major-typesA comma-separated list of conventional commit types that trigger a major version change.
minor-typesA comma-separated list of conventional commit types that trigger a minor version change. It defaults to `feat`
prepend-version-to-release-titleWhether to prepend the release version to the release title. Note: this only applies when `get-release-title-from-pr` is `true`.false
release-branchThe name of the branch to publish the release to.release
release-titleThe title to use for the GitHub release. If not set, or an empty string, the release tag name will be used.
tracking-tagThe name of the tag to put on the source branch to track the source of the latest Release.latest-src
version-overrideThe version to use for publishing the package instead of determining the version using conventional commits.
namedescription
current-versionThe version of the package before it is updated.
increment-typeThe type of version increment (if applicable) in ['major', 'minor', 'patch'].
next-versionThe new version of the package (ex. '1.2.3').
next-version-majorThe major portion of the new version of the package (ex. '1').
next-version-minorThe minor portion of the new version of the package (ex. '2').
next-version-patchThe patch portion of the new version of the package (ex. '3').