offload-project/Release Champion

Automated semantic versioning and releases using conventional commits

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
github-tokenGitHub token for creating PRs, tags, and releasesyes
release-labelLabel that marks a PR for releasenochange-release
require-release-labelRequire the release label to trigger a release PR. When false, every merged PR triggers a release.nofalse
version-prefixPrefix for version tags (e.g., "v" produces "v1.2.3")nov
create-tagCreate a git tag when the release PR is mergednotrue
create-releaseCreate a GitHub release when the release PR is mergednotrue
draft-releaseCreate the GitHub release as a draft (unpublished)notrue
changelogGenerate or update CHANGELOG.md in the release PRnotrue
publish-npmPublish the package to an npm registry when the release PR is mergednofalse
npm-tokenAuth token for the npm registry. If omitted and the workflow grants id-token:write, npm Trusted Publishers (OIDC) is used (requires npm >= 11.5.1). If omitted with no OIDC, the publish relies on existing npm auth (e.g. setup-node with NODE_AUTH_TOKEN) and the action will not write or overwrite .npmrc.no
npm-registrynpm registry URL (e.g., https://npm.pkg.github.com for GitHub Packages)nohttps://registry.npmjs.org
npm-build-commandBuild command to run before npm publish (e.g., npm run build). Dependencies are installed first with the package manager detected from the lockfile (npm, yarn, pnpm, or bun) using a frozen-lockfile install.no
npm-workspacesPublish every npm workspace package (monorepo, fixed/locked versioning). All packages share the single computed version. Discovered from the root package.json "workspaces" field.nofalse
namedescription
versionThe new version string (e.g., "1.2.3")
release-prURL of the created release PR (Phase 1)
tagThe created tag name (Phase 2)
release-urlURL of the created GitHub release (Phase 2)