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
@@ -232,3 +225,19 @@ Apache License 2.0 — see [LICENSE.md](LICENSE.md)
232
225
## Conda-forge feedstock
233
226
234
227
See `CONDA_FORGE_FEEDSTOCK_PLAN.md` for the steps and follow-up tasks to submit and maintain the conda-forge feedstock for `fremorizer`.
228
+
229
+
## Releases and Versioning
230
+
231
+
`fremorizer` uses a post-release scheme to identify development beyond the latest tagged version and tie the current `main` branch to a
232
+
`conda` package versioned as `develop`. To avoid confusion with `fre-workflows` and `fre-cli`, which often demand that the version tags
233
+
match, `fremorizer`'s version format is `X.Y.Z[.post]`.
234
+
235
+
### new published release procedure
236
+
237
+
To publish new release carefully follow the below procedure:
238
+
1. create a new branch off of `main`, which is already published to `conda` under `develop`/the previous tagged version + `.post`
239
+
2. edit the version number in `fremorizer/_version.py` from the current one, to the desired version tag, remove `.post`, then open a PR. edit nothing else (usually).
240
+
3. confirm the branch is functional by letting workflows finish, if you see green checks only, proceed. otherwise, stop and debug.
241
+
4. draft a new release pointing to the PR branch, click release. the publishing workflow should trigger and finish, and you should see the `X.Y.Z` version in the conda channel.
242
+
5.*releases in this repository are immutable*, **so even if the release workflow fails, breathe and move on to the next step.**
243
+
6. edit the version number in `fremorizer/_version.py` to `X.Y.Z.post`, and merge the PR to main workflow steps passed. **`publish_conda`** will trigger again and upload what is in `main` under the `conda` version `develop` and `pip` version `X.Y.Z.post`
0 commit comments