offload-project/Release Champion
Automated semantic versioning and releases using conventional commits
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github-token | GitHub token for creating PRs, tags, and releases | yes | — |
| release-label | Label that marks a PR for release | no | change-release |
| require-release-label | Require the release label to trigger a release PR. When false, every merged PR triggers a release. | no | false |
| version-prefix | Prefix for version tags (e.g., "v" produces "v1.2.3") | no | v |
| create-tag | Create a git tag when the release PR is merged | no | true |
| create-release | Create a GitHub release when the release PR is merged | no | true |
| draft-release | Create the GitHub release as a draft (unpublished) | no | true |
| changelog | Generate or update CHANGELOG.md in the release PR | no | true |
| publish-npm | Publish the package to an npm registry when the release PR is merged | no | false |
| npm-token | Auth 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-registry | npm registry URL (e.g., https://npm.pkg.github.com for GitHub Packages) | no | https://registry.npmjs.org |
| npm-build-command | Build 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-workspaces | Publish every npm workspace package (monorepo, fixed/locked versioning). All packages share the single computed version. Discovered from the root package.json "workspaces" field. | no | false |
Outputs
| name | description |
|---|---|
| version | The new version string (e.g., "1.2.3") |
| release-pr | URL of the created release PR (Phase 1) |
| tag | The created tag name (Phase 2) |
| release-url | URL of the created GitHub release (Phase 2) |