You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update RELEASING.md for custom version format
Clarify that Release-As: should be used to specify versions
due to the custom version format (X.Y.Z-alpha.N.P).
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5 <[email protected]>
Copy file name to clipboardExpand all lines: RELEASING.md
+27-30Lines changed: 27 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,63 +2,62 @@
2
2
3
3
This document describes the release process for Fable.Python and how to keep versions in sync with Fable.
4
4
5
-
## Version Synchronization with Fable
5
+
## Version Format
6
6
7
-
Fable.Python versions should stay in sync with Fable. For example, if Fable releases `5.0.0-alpha.21`, Fable.Python should release `5.0.0-alpha.21.0`.
7
+
Fable.Python uses the version format `X.Y.Z-alpha.N.P` where:
8
8
9
-
## Release Process
10
-
11
-
This project uses [release-please](https://github.com/googleapis/release-please) to automate releases. Release-please creates and maintains a release PR that updates automatically as commits are merged to main.
9
+
-`X.Y.Z-alpha.N` matches the Fable version (e.g., `5.0.0-alpha.21`)
10
+
-`P` is the patch version for Fable.Python releases (0, 1, 2, etc.)
12
11
13
-
The configuration uses `"versioning": "always-bump-patch"` which means every release only increments the patch version (e.g., `5.0.0-alpha.21.0` → `5.0.0-alpha.21.1` → `5.0.0-alpha.21.2`).
2. Release-please automatically creates/updates a release PR
21
-
3. Merge the release-please PR when ready
22
-
4. The GitHub Action will create a release and tag
16
+
This project uses [release-please](https://github.com/googleapis/release-please) to automate releases. Release-please creates and maintains a release PR that updates automatically as commits are merged to main.
23
17
24
-
The patch version increments automatically regardless of commit type.
18
+
**Important:** Due to the custom version format, use `Release-As:` to specify the version.
25
19
26
-
### Syncing with a New Fable Version
20
+
### Setting the Version
27
21
28
-
When Fable releases a new version (e.g., `5.0.0-alpha.21`), use the `Release-As` footer to override the version:
22
+
Add `Release-As:` in the commit message or PR description:
29
23
30
24
#### In the commit message
31
25
32
26
```text
33
-
chore: sync with Fable 5.0.0-alpha.21
27
+
feat: add new feature
34
28
35
-
Release-As: 5.0.0-alpha.21.0
29
+
Release-As: 5.0.0-alpha.21.1
36
30
```
37
31
38
32
#### In the PR description
39
33
40
34
Add this line anywhere in the PR body:
41
35
42
36
```text
43
-
Release-As: 5.0.0-alpha.21.0
37
+
Release-As: 5.0.0-alpha.21.1
44
38
```
45
39
46
-
Release-please will use the specified version instead of bumping the patch.
40
+
Release-please will use the specified version for the release.
47
41
48
-
### Hotfix Releases
42
+
### Syncing with a New Fable Version
49
43
50
-
After syncing with a Fable version, subsequent patches are automatic:
44
+
When Fable releases a new version (e.g., `5.0.0-alpha.22`):
51
45
52
-
-`5.0.0-alpha.21.0` (initial sync with Fable)
53
-
-`5.0.0-alpha.21.1` (first hotfix)
54
-
-`5.0.0-alpha.21.2` (second hotfix)
55
-
- etc.
46
+
1. Update the codebase to work with the new Fable version
47
+
2. Use `Release-As: 5.0.0-alpha.22.0` in the commit or PR
48
+
3. Merge the release-please PR
56
49
57
-
This clearly shows the relationship to the base Fable version and sorts correctly in package managers.
50
+
### Version History Example
51
+
52
+
-`5.0.0-alpha.21.0` (initial sync with Fable 5.0.0-alpha.21)
53
+
-`5.0.0-alpha.21.1` (first patch)
54
+
-`5.0.0-alpha.21.2` (second patch)
55
+
-`5.0.0-alpha.22.0` (sync with Fable 5.0.0-alpha.22)
0 commit comments