feat: Automatic version bumping from configured targets by BYK · Pull Request #707 · getsentry/craft

BYK · 2026-01-12T22:28:35Z

Summary

When minVersion >= 2.21.0 and no custom preReleaseCommand is defined, Craft automatically bumps version numbers based on configured publish targets. This eliminates the need for a scripts/bump-version.sh script in most cases.

How It Works

Craft examines configured targets in .craft.yml
For each target that supports version bumping, it updates the appropriate project files
Targets are processed in config order, deduplicated by type

Supported Targets

Target	Detection	Version Bump Method
`npm`	`package.json`	`npm version --no-git-tag-version`
`pypi`	`pyproject.toml`	hatch, poetry, setuptools-scm, or direct edit
`crates`	`Cargo.toml`	`cargo set-version` (cargo-edit)
`gem`	`*.gemspec`	Direct edit of gemspec + `lib/**/version.rb`
`pub-dev`	`pubspec.yaml`	Direct edit
`hex`	`mix.exs`	Direct edit
`nuget`	`*.csproj`	dotnet-setversion or direct XML edit

Python (pypi) Detection Priority

[tool.hatch] → hatch version <version>
[tool.poetry] → poetry version <version>
[tool.setuptools_scm] → No-op (version from git tags)
[project] with version → Direct TOML edit

Breaking Changes

None. Existing projects continue to work unchanged. The feature is gated behind minVersion: "2.21.0".

Fixes #76

When minVersion >= 2.19.0 and no preReleaseCommand is defined, Craft automatically bumps version numbers based on configured publish targets. Supported targets: - npm: npm version --no-git-tag-version - pypi: hatch, poetry, setuptools-scm, or direct pyproject.toml edit - crates: cargo set-version (cargo-edit) - gem: Direct edit of gemspec and lib/**/version.rb - pub-dev: Direct edit of pubspec.yaml - hex: Direct edit of mix.exs - nuget: dotnet-setversion or direct XML edit Fixes #76

github-actions · 2026-01-12T22:28:50Z

Semver Impact of This PR

🟡 Minor (new features)

📋 Changelog Preview

This is how your changes will appear in the changelog.
Entries from this PR are highlighted with a left border (blockquote style).

New Features ✨

Automatic version bumping from configured targets by BYK in #707

_{🤖 This preview updates automatically when you update the PR.}

For npm/yarn/pnpm monorepos, automatically detect and bump versions in all workspace packages: - npm 7+: Uses npm version --workspaces - yarn/pnpm or npm < 7: Falls back to individual package bumping Private packages are skipped during workspace version bumping.

Tests cover: - runAutomaticVersionBumps utility function - NpmTarget.bumpVersion (including workspace detection) - PypiTarget.bumpVersion (hatch, poetry, setuptools-scm, direct edit) - CratesTarget.bumpVersion - GemTarget.bumpVersion - PubDevTarget.bumpVersion - HexTarget.bumpVersion - NugetTarget.bumpVersion

- Remove obvious comments (// Check if X exists) - Simplify verbose multi-line comments to single lines - Remove redundant JSDoc field descriptions - Clean up try/catch blocks with explicit early returns - Shorten verbose error messages

…mock setup

src/targets/gem.ts

betegon · 2026-01-13T10:36:29Z

docs/src/content/docs/configuration.md

+For npm/yarn/pnpm monorepos, Craft automatically detects and bumps versions in all workspace packages:
+
+- **npm 7+**: Uses `npm version --workspaces` to bump all packages at once
+- **yarn/pnpm or npm < 7**: Falls back to bumping each non-private package individually


where's my dear Bun? we can add it later, i think we could just look for Bun lockfiles bun.lockb / bun.lock, add BUN_BIN, USE_BUN env vars, and bun publishsupport.

it supports workspaces too https://bun.com/docs/pm/workspaces

BYK · 2026-01-30T22:24:32Z

Re: Gem monorepo support

Updated! The gem target now searches for .gemspec files up to 2 levels deep, respecting .gitignore patterns. This supports monorepo structures like:

sentry-ruby/sentry-ruby.gemspec (depth 1)
packages/gem-name/gem-name.gemspec (depth 2)

The implementation uses the ignore npm package for gitignore parsing and async fs/promises APIs.

Re: Bun support

Great suggestion! Bun support (lockfile detection via bun.lockb/bun.lock, BUN_BIN/USE_BUN env vars, bun publish, and workspace support) would be a valuable addition. I'll address this in a follow-up PR to keep this one focused on the automatic version bumping feature.

- Add 'ignore' package for gitignore-aware file traversal - Add findFiles() utility that respects .gitignore patterns - Update GemTarget.bumpVersion() to search up to 2 levels deep - Convert gem target methods to async fs/promises APIs - Add tests for monorepo support (sentry-ruby style)

github-actions · 2026-01-30T22:32:53Z

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-01-30 23:59 UTC

src/commands/prepare.ts

src/targets/pypi.ts

src/utils/files.ts

docs/src/content/docs/configuration.md

Addresses PR review comments to update the minimum version required for automatic version bumping from targets to 2.21.0, which will be the release version for this feature.

Replace readdir with opendir and async for...of loop for more memory-efficient directory traversal. The async iterator processes entries one at a time rather than loading all entries into memory. Addresses PR review feedback.

Add helper functions to centralize the common pattern of: 1. Resolving executable path (with optional env var override) 2. Checking if executable exists 3. Throwing helpful error if not found 4. Running the command with debug logging New exports in system.ts: - ExecutableConfig: interface for configuring executable resolution - resolveExecutable(): resolve binary path from config - runWithExecutable(): check and run executable in one call Updated targets to use the new helper: - pypi.ts: bumpWithHatch, bumpWithPoetry - crates.ts: bumpVersion Closes #738

Add support for trying multiple executables in order: - findFirstExecutable(): finds first available from array of configs - requireFirstExecutable(): same but throws if none found - runWithExecutable(): now accepts single config or array Updated npm.ts to use the new abstraction: - Uses requireFirstExecutable([NPM_CONFIG, YARN_CONFIG]) - Returns index to determine which executable was found - Replaces manual hasExecutable checks with cleaner pattern

…ling - Mock runWithExecutable in tests since it calls hasExecutable internally - Use module-scope mock functions for proper test configuration - Remove explicit dir.close() since for-await-of handles cleanup automatically

vi.mock is hoisted to top of file, so mock functions must be created with vi.hoisted() to be available during the mock factory execution.

BYK · 2026-01-30T23:25:24Z

@sentry review

BYK · 2026-01-30T23:25:31Z

@cursoragent review

cursor · 2026-01-30T23:25:39Z

Perfect! I've completed a comprehensive review of this PR. Let me provide you with my findings.

Code Review Summary

Overall Assessment ✅

This is a well-designed and thoroughly implemented feature that adds automatic version bumping for multiple package ecosystems. The code quality is excellent, with comprehensive tests and good documentation.

Strengths

Architecture: Clean abstraction with the VersionBumpableTarget interface that targets implement as static methods
Test Coverage: Comprehensive tests covering all target implementations and edge cases (788 tests pass)
Error Handling: Good error messages with helpful hints (e.g., "Install cargo-edit: cargo install cargo-edit")
Dry-run Support: All destructive operations properly respect dry-run mode
Helper Abstraction: The runWithExecutable() helper eliminates code duplication across targets
Monorepo Support:
- npm/yarn workspace detection and bulk version bumping
- Gem target searches for gemspec files up to 2 levels deep with gitignore support
Documentation: Clear docs explaining the feature, detection priority, and supported targets

Key Implementation Details

Version Bump Flow:

prepare.ts calls runAutomaticVersionBumps() when minVersion >= 2.21.0 and no custom preReleaseCommand
Targets are deduplicated by type (multiple npm targets only bump package.json once)
Each target's bumpVersion() static method:
- Detects if the project uses that ecosystem
- Returns false if detection fails (not applicable)
- Returns true after successfully bumping
- Throws on errors with helpful messages

Target Implementations:

npm: Uses npm version --no-git-tag-version with workspace support
pypi: Smart detection (hatch → poetry → setuptools_scm → direct edit)
crates: Uses cargo set-version from cargo-edit
gem: Direct file editing with monorepo support
nuget: Tries dotnet-setversion first, falls back to XML editing
pub-dev/hex: Direct YAML/Elixir file editing

Minor Issues Found (Non-blocking)

Unused import in crates.ts (line 17):

import { logger } from '../logger';  // Only used in bumpVersion, not in main class

Minor warning in system.ts (line 289):

catch (e) {  // 'e' defined but never used

Documentation could mention:
- What happens if version bump succeeds but later steps fail (git state)
- Recommended approach for projects that need custom pre-processing

Addressed PR Comments

All previous PR feedback has been addressed:

✅ AUTO_BUMP_MIN_VERSION constant used throughout
✅ runWithExecutable() helper abstracts the executable pattern
✅ opendir with async iterator for gem target
✅ Gem monorepo support (2 levels deep, gitignore-aware)
✅ minVersion: "2.21.0" updated in all examples

Recommendations

Consider adding a warning when automatic bumping runs but finds no applicable targets (currently just logs at debug level)
Document recovery: Add a note about what to do if version bump succeeds but prepare fails mid-way
Future enhancement: Consider allowing per-target version bump customization for monorepos where different packages might need different versions

Testing

✅ All 788 tests pass
✅ Build succeeds
✅ Linter passes (161 warnings are all pre-existing or minor unused vars)
✅ E2E tests verify dry-run behavior

Final Verdict

APPROVED ✅

This PR is ready to merge. The implementation is solid, well-tested, and follows the project's coding standards. The automatic version bumping feature will significantly improve the developer experience by eliminating the need for custom bump-version scripts in most cases.

The feature is properly gated behind minVersion: "2.21.0" ensuring backward compatibility, and the fallback to custom preReleaseCommand is well-designed.

- Return detailed VersionBumpResult from runAutomaticVersionBumps - Provide specific warnings for: - No targets support version bumping - Targets support it but didn't find applicable files - Add recovery documentation for failed prepare after version bump - Update tests for new return type

BYK requested review from Lms24, hubertdeng123, sentrivana and sl0thentr0py January 12, 2026 22:36

BYK added 5 commits January 12, 2026 22:39

chore: Remove AI slop from version bumping code

cbf5382

- Remove obvious comments (// Check if X exists) - Simplify verbose multi-line comments to single lines - Remove redundant JSDoc field descriptions - Clean up try/catch blocks with explicit early returns - Shorten verbose error messages

fix: escape glob pattern in JSDoc comment to fix esbuild parsing

4a51037

fix: update tests for new runPreReleaseCommand signature and improve …

983696f

…mock setup

BYK temporarily deployed to false January 13, 2026 00:20 — with GitHub Actions Inactive

sl0thentr0py reviewed Jan 13, 2026

View reviewed changes

src/targets/gem.ts Outdated Show resolved Hide resolved

betegon reviewed Jan 13, 2026

View reviewed changes

Merge branch 'master' into feat/auto-version-bump-from-targets

6738f7e

BYK temporarily deployed to false January 30, 2026 22:33 — with GitHub Actions Inactive

BYK marked this pull request as ready for review January 30, 2026 22:34

BYK commented Jan 30, 2026

View reviewed changes

chore: update AUTO_BUMP_MIN_VERSION from 2.19.0 to 2.21.0

662afed

Addresses PR review comments to update the minimum version required for automatic version bumping from targets to 2.21.0, which will be the release version for this feature.

BYK temporarily deployed to false January 30, 2026 22:50 — with GitHub Actions Inactive

BYK mentioned this pull request Jan 30, 2026

refactor: Abstract executable detection and invocation pattern #738

Closed

BYK added 6 commits January 30, 2026 22:59

refactor: use opendir with async iterator in walkDirectory

e65c06b

Replace readdir with opendir and async for...of loop for more memory-efficient directory traversal. The async iterator processes entries one at a time rather than loading all entries into memory. Addresses PR review feedback.

fix: use vi.hoisted for mock functions in versionBump tests

131a978

vi.mock is hoisted to top of file, so mock functions must be created with vi.hoisted() to be available during the mock factory execution.

fix: remove duplicate code in versionBump tests

18cc4c3

BYK temporarily deployed to false January 30, 2026 23:22 — with GitHub Actions Inactive

chore: remove unused import and catch variable

53fa19f

BYK temporarily deployed to false January 30, 2026 23:42 — with GitHub Actions Inactive

BYK temporarily deployed to false January 30, 2026 23:47 — with GitHub Actions Inactive

BYK merged commit d62ca92 into master Jan 30, 2026
16 checks passed

BYK deleted the feat/auto-version-bump-from-targets branch January 30, 2026 23:58

This was referenced Feb 6, 2026

publish: getsentry/craft@2.21.0 getsentry/publish#7083

Closed

publish: getsentry/craft@2.21.0 getsentry/publish#7084

Closed

publish: getsentry/craft@2.21.1 getsentry/publish#7085

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Automatic version bumping from configured targets#707

feat: Automatic version bumping from configured targets#707
BYK merged 17 commits intomasterfrom
feat/auto-version-bump-from-targets

BYK commented Jan 12, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Jan 12, 2026 •

edited

Loading

Uh oh!

Uh oh!

betegon Jan 13, 2026

Uh oh!

betegon Jan 13, 2026

Uh oh!

BYK commented Jan 30, 2026

Uh oh!

github-actions bot commented Jan 30, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BYK commented Jan 30, 2026

Uh oh!

BYK commented Jan 30, 2026

Uh oh!

cursor bot commented Jan 30, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

BYK commented Jan 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

How It Works

Supported Targets

Python (pypi) Detection Priority

Breaking Changes

Uh oh!

github-actions bot commented Jan 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Semver Impact of This PR

📋 Changelog Preview

New Features ✨

Uh oh!

Uh oh!

betegon Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

betegon Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

BYK commented Jan 30, 2026

Uh oh!

github-actions bot commented Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BYK commented Jan 30, 2026

Uh oh!

BYK commented Jan 30, 2026

Uh oh!

cursor bot commented Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Summary

Overall Assessment ✅

Strengths

Key Implementation Details

Minor Issues Found (Non-blocking)

Addressed PR Comments

Recommendations

Testing

Final Verdict

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

BYK commented Jan 12, 2026 •

edited

Loading

github-actions bot commented Jan 12, 2026 •

edited

Loading

github-actions bot commented Jan 30, 2026 •

edited

Loading

cursor bot commented Jan 30, 2026 •

edited

Loading