Composite GitHub Action — opens a PR bumping a version key in a properties file after a successful release. Optionally enables auto-merge.
Companion to mbl-actionhub-resolve-version: the resolver reads the committed value before publishing; this action bumps the committed value after publishing so the next cycle has a valid sanity-check target.
- Computes
next-versionfrompublished-version+bump-type. - Edits
properties-keyinproperties-pathto the new value. - Creates branch
{branch-prefix}-{next-version}. - Commits + pushes.
- Opens a PR against
base-branch. - (Optional) Enables auto-merge
--squashon the PR. - Skips cleanly if the bump branch already exists (re-run safe).
- uses: actions/checkout@v6
with:
ref: ${{ github.ref }}
fetch-depth: 0
- uses: MobileByteLabs/mbl-actionhub-bump-version@v1.0.0
with:
published-version: '3.2.3'
properties-key: 'kmptoolkit.version'
bump-type: 'patch'After publishing v3.2.3, this opens a PR setting kmptoolkit.version=3.2.4 in gradle.properties and enables auto-merge.
| Input | Required | Default | Description |
|---|---|---|---|
published-version |
Yes | — | Version that was just published (e.g. 3.2.3) |
properties-key |
Yes | — | Key to update (e.g. kmptoolkit.version) |
properties-path |
No | gradle.properties |
Path to file |
bump-type |
No | patch |
patch / minor / major / prerelease-graduate — see Pre-release-aware bumping |
base-branch |
No | ${{ github.ref_name }} |
Target branch for the PR |
branch-prefix |
No | chore/bump-version |
Branch name prefix |
pr-title |
No | chore(version): bump {key} to {next} (post-release) |
Title; supports {key}, {next}, {published} |
auto-merge |
No | true |
Enable auto-merge --squash on PR (best-effort) |
delete-branch-on-merge |
No | true |
Pass --delete-branch to gh pr merge |
github-token |
No | ${{ github.token }} |
Token for git push + gh pr ops |
git-user-name / git-user-email |
No | github-actions[bot] defaults |
Commit author identity |
| Output | Description |
|---|---|
next-version |
Computed next version |
pr-url |
URL of the opened PR (empty if skipped) |
pr-number |
PR number (empty if skipped) |
branch |
Bump branch name |
skipped |
true if the bump was skipped (branch already existed) |
If your base-branch requires PR review approvals or status checks and uses the default GITHUB_TOKEN, GitHub blocks pushes/PRs that match those rules from triggering downstream workflows. To make the PR's CI run normally, pass a PAT or app token via github-token.
- uses: MobileByteLabs/mbl-actionhub-bump-version@v1.0.0
with:
published-version: ${{ needs.publish.outputs.version }}
properties-key: 'kmptoolkit.version'
github-token: ${{ secrets.RELEASE_BOT_TOKEN }} # PAT with repo + workflow scopesAs of v1.6.0 the bumper recognises SemVer 2.0.0 pre-release suffixes -alpha.N, -beta.N, -rc.N (period-separated counter form) and bumps them intelligently instead of stripping them.
published-version |
bump-type |
next-version |
When to use |
|---|---|---|---|
2.2.0-alpha.0 |
patch (default) |
2.2.0-alpha.1 |
Continue the alpha cycle |
2.2.0-beta.2 |
patch |
2.2.0-beta.3 |
Continue the beta cycle |
2.2.0-rc.5 |
patch |
2.2.0-rc.6 |
Continue the rc cycle |
2.2.0-rc.5 |
prerelease-graduate |
2.2.0 |
Cut the GA from the last rc — drop the suffix |
2.2.0-alpha.0 |
minor |
2.3.0 |
Consume the alpha line + bump minor |
2.2.0-alpha.0 |
major |
3.0.0 |
Consume the alpha line + bump major |
2.2.0 |
patch |
2.2.1 |
GA patch — historical behaviour |
2.2.0-snapshot.1 |
patch |
2.2.1 |
Unrecognised suffix falls through to strip+patch |
Suffix detection is strict: only -alpha.N, -beta.N, -rc.N (lowercase, period-separated integer counter) trigger the pre-release-aware path. Custom suffixes (-pre.1, -snapshot.1, -build.7) fall through to the historical strip-and-patch-bump path for backwards-compatibility.
For multi-stage publish workflows the typical orchestration is:
# Default — continue the same pre-release line on every alpha publish.
- uses: MobileByteLabs/mbl-actionhub-bump-version@v1.6.0
with:
published-version: ${{ needs.publish.outputs.version }}
properties-key: 'kmpflavors.version'
bump-type: 'patch'
# When cutting the GA from the last rc, override to prerelease-graduate.
- uses: MobileByteLabs/mbl-actionhub-bump-version@v1.6.0
if: contains(needs.publish.outputs.version, '-rc.')
with:
published-version: ${{ needs.publish.outputs.version }}
properties-key: 'kmpflavors.version'
bump-type: 'prerelease-graduate'If the workflow is re-run after a successful release, the bump branch from the original run will already exist. This action detects that and exits early with skipped=true — no duplicate PR, no force-push.
- Invalid
published-version(not semverX.Y.Z) → fails before any changes. - Properties key not found in file → fails before any changes.
- Push fails (auth, branch protection) → fails after edit but before PR creation. Caller can retry.
- Auto-merge can't be enabled (repo setting / branch protection) → warning only; PR stays open.
tests/run-tests.sh covers computation, output writing, error paths, and PR title substitution. Uses BUMP_DRY_RUN=true to short-circuit before any network operations.
bash tests/run-tests.shCI runs the suite on every PR via .github/workflows/test.yml.