glitch452/Easy Npm Publish

Use Conventional Commits to automatically update the package version, update the git tags and publish the package.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
github-tokenA github token with access to write tags and releases to the repository.
registry-tokenAn auth token with access to publish to the registry. If one is not provided, OIDC auth must be configured for the publish to work.no
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
dry-runRun the action without actually publishing the package, pushing git tags, or creating a GitHub release.false
enable-github-releaseCreate a GitHub Release.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`
npmrc-contentManually set the contents of the .npmrc file written to the `npmrc-path` location.
npmrc-pathA path to the `.npmrc` file. Defaults to `$HOME/.npmrc`.
package-directoryThe path to the directory containing the package to be published. It must be a relative path, relative to the root of the repository. It defaults to the root of the repository.
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
privateWhether to publish the package as a `private` package.false
registry-urlThe URL of the package registry to publish to. It defaults to npm's registry `registry.npmjs.org`.
release-titleThe title to use for the GitHub release. If not set, or an empty string, the release tag name will be used.
scripts-package-directoryThe path to a directory containing a package.json file which contains the project's scripts. Set this to use a custom `publish` script in the package.json file. It must be a relative path, relative to the root of the repository. It defaults to the value of the `package-directory` input.
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').