Skip to content

Commit f8fbc5f

Browse files
Update release documentation to include pre-release version format
1 parent 230d190 commit f8fbc5f

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

docs/contributor-info/releasing.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ rake release[version,dry_run,registry,skip_push]
2121
1. **`version`** (required): Version bump type or explicit version
2222

2323
- Bump types: `patch`, `minor`, `major`
24-
- Explicit: `16.2.0` (rubygem format, no dashes)
24+
- Explicit: `16.2.0`
25+
- Pre-release: `16.2.0.beta.1` (rubygem format with dots, converted to `16.2.0-beta.1` for NPM)
2526

2627
2. **`dry_run`** (optional): `true` to preview changes without releasing
2728

@@ -43,6 +44,7 @@ rake release[patch] # Bump patch version (16.1.1 → 16
4344
rake release[minor] # Bump minor version (16.1.1 → 16.2.0)
4445
rake release[major] # Bump major version (16.1.1 → 17.0.0)
4546
rake release[16.2.0] # Set explicit version
47+
rake release[16.2.0.beta.1] # Set pre-release version (→ 16.2.0-beta.1 for NPM)
4648
rake release[16.2.0,true] # Dry run to preview changes
4749
rake release[16.2.0,false,verdaccio] # Test with local Verdaccio
4850
rake release[patch,false,npm,skip_push] # Release but don't push to GitHub

rakelib/release.rake

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ updated to the same version number and released together.
2222
2323
Version argument can be:
2424
- Semver bump type: 'patch', 'minor', or 'major' (e.g., 16.1.1 → 16.1.2, 16.2.0, or 17.0.0)
25-
- Explicit version: '16.2.0' (in rubygem format, no dashes)
25+
- Explicit version: '16.2.0'
26+
- Pre-release version: '16.2.0.beta.1' (rubygem format with dots, converted to 16.2.0-beta.1 for NPM)
2627
2728
This will update and release:
2829
PUBLIC (npmjs.org + rubygems.org):
@@ -43,6 +44,7 @@ Examples:
4344
rake release[minor] # Bump minor version (16.1.1 → 16.2.0)
4445
rake release[major] # Bump major version (16.1.1 → 17.0.0)
4546
rake release[16.2.0] # Set explicit version
47+
rake release[16.2.0.beta.1] # Set pre-release version (→ 16.2.0-beta.1 for NPM)
4648
rake release[patch,true] # Dry run
4749
rake release[16.2.0,false,verdaccio] # Test with Verdaccio
4850
rake release[16.2.0,false,npm,skip_push] # Release without pushing to remote")

0 commit comments

Comments
 (0)