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
fix: add develop-specific release-please files and update workflow
- Add .release-please-config-develop.json with prerelease: true
- Add .release-please-manifest-develop.json with current version
- Remove dynamic file creation from workflow
- Files are now committed to repo instead of generated at runtime
Copy file name to clipboardExpand all lines: docs/RELEASES.md
+36-10Lines changed: 36 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,6 +54,8 @@ This ensures that alpha and stable releases have distinct version numbers and pu
54
54
- Creates GitHub release marked as "pre-release"
55
55
- Publishes to TestPyPI (if version > 0.3.2)
56
56
57
+
**Note**: The develop branch uses separate configuration files (`.release-please-config-develop.json` and `.release-please-manifest-develop.json`) to ensure proper alpha version tracking independent of the main branch.
58
+
57
59
### For Stable Releases (Main Branch)
58
60
59
61
1.**Merge from develop** (or commit directly):
@@ -75,17 +77,32 @@ This ensures that alpha and stable releases have distinct version numbers and pu
75
77
76
78
## Version Numbering
77
79
80
+
### How Version Tracking Works
81
+
82
+
Release Please uses manifest files to track the "last released version" for each branch:
83
+
84
+
-**`.release-please-manifest.json`**: Tracks the last stable release from main branch
85
+
-**`.release-please-manifest-develop.json`**: Tracks the last alpha release from develop branch
86
+
87
+
When Release Please runs, it:
88
+
1. Reads the manifest to find the last released version
89
+
2. Analyzes conventional commits since that version
90
+
3. Calculates the next version based on commit types (feat, fix, etc.)
91
+
4. For develop branch: Applies alpha suffix due to prerelease configuration
python -c "import otdf_python; print('Stable version works!')"
@@ -149,9 +166,16 @@ Release Please automatically updates version references in both packages using t
149
166
- Verify PyPI trusted publisher configuration
150
167
- Ensure version doesn't already exist on the target repository
151
168
169
+
### Release Please Configuration Errors
170
+
-**Error: "Missing required manifest versions"**: Ensure both `.release-please-config-develop.json` and `.release-please-manifest-develop.json` are committed to the repository
171
+
-**Dynamic file creation errors**: The develop-specific configuration files must exist in the repository, not generated at runtime
172
+
-**Wrong branch configuration**: Verify the workflow uses the correct config and manifest files for each branch
173
+
152
174
### Version Conflicts
153
-
- Alpha and stable releases use different version formats, preventing conflicts
154
-
- If conflicts occur, check the Release Please manifest and config files
175
+
- Alpha and stable releases use separate configuration and manifest files to prevent conflicts
176
+
- Develop branch uses `.release-please-config-develop.json` and `.release-please-manifest-develop.json`
177
+
- Main branch uses `.release-please-config.json` and `.release-please-manifest.json`
178
+
- If conflicts occur, check the appropriate Release Please configuration files for the target branch
155
179
156
180
## Emergency Procedures
157
181
@@ -166,8 +190,10 @@ git push origin main
166
190
167
191
## Configuration Files
168
192
169
-
-`.release-please-config.json`: Main configuration
170
-
-`.release-please-manifest.json`: Version tracking
193
+
-`.release-please-config.json`: Main branch release configuration (stable releases)
194
+
-`.release-please-manifest.json`: Main branch version tracking
0 commit comments