Skip to content

Commit 68ab12a

Browse files
authored
Merge pull request #81 from ilaflott/tag-0.1.2
Tag 0.1.2
2 parents d02d7a2 + f027685 commit 68ab12a

File tree

2 files changed

+13
-8
lines changed

2 files changed

+13
-8
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -209,11 +209,16 @@ See `CONDA_FORGE_FEEDSTOCK_PLAN.md` for the steps and follow-up tasks to submit
209209

210210
## Releases and Versioning
211211

212-
`fremorizer` has it's own versioning approach/format to avoid confusion with `fre-workflows` and `fre-cli`, which often demand that the version tags match.
213-
the version format is `X.Y.Z`. To publish new release carefully follow the below procedure:
214-
1. create a new branch off of `main`
215-
2. edit the version number in `fremorizer/_version.py` to the desired version tag and open a PR
212+
`fremorizer` uses a post-release scheme to identify development beyond the latest tagged version and tie the current `main` branch to a
213+
`conda` package versioned as `develop`. To avoid confusion with `fre-workflows` and `fre-cli`, which often demand that the version tags
214+
match, `fremorizer`'s version format is `X.Y.Z[.post]`.
215+
216+
### new published release procedure
217+
218+
To publish new release carefully follow the below procedure:
219+
1. create a new branch off of `main`, which is already published to `conda` under `develop`/the previous tagged version + `.post`
220+
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).
216221
3. confirm the branch is functional by letting workflows finish, if you see green checks only, proceed. otherwise, stop and debug.
217-
4. draft a new release pointing to the PR branch, click release. the publishing workflow should trigger and finish.
218-
5. releases in this repository are immutable, **so even if the release workflow fails, breathe and move on to the next step.**
219-
6. edit the version number in `fremorizer/_version.py` to `postX.Y.Z`, and merge the PR assuming all workflow steps passed.
222+
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.
223+
5. *releases in this repository are immutable*, **so even if the release workflow fails, breathe and move on to the next step.**
224+
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`

fremorizer/_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@
33
"""
44

55
import os
6-
version = os.getenv("GIT_DESCRIBE_TAG", "post0.1.1")
6+
version = os.getenv("GIT_DESCRIBE_TAG", "0.1.2.post")
77
__version__ = version

0 commit comments

Comments
 (0)