Release/0.1.0 #20
Release/0.1.0 #20
Conversation
✅ Result of Pytest Coverage---------- coverage: platform darwin, python 3.11.8-final-0 ----------
|
| @@ -0,0 +1,5 @@ | |||
| ## 0.1.0 (2024-03-10) | |||
There was a problem hiding this comment.
We already have a changelog file in the docs folder.
https://github.com/kausalflow/hamilflow/blob/main/docs/changelog.md
Not sure which is better. Choose whichever you prefer.
We need a changelog file in the docs folder. But if you choose this current file, I can easily add a hook in the pre commit confit to automatically copy it to docs. So either ways.
|
Comment about releases: It is easier to automate stuff it we have a tag for each release. It has not been configured yet but we will have a automatic releasing step in Actions. The step can be easily triggered by a tag such as v0.1.0. |
| - Squash merge all features to a branch, e.g. `main` or `release/cmp0xff/candidate` | ||
| - Use `feat(section): xxx`, `fix(section): yyy`, `chore(poetry): lock` etc as the squashed commit messages | ||
| - Run `cz bump --dry` to determine the new version `X.Y.Z`. Or check out the [documentation](https://commitizen-tools.github.io/commitizen/bump/) for imposing a version | ||
| - Run `git checkout release/X.Y.Z` (-b? not sure... I have always been using SourceTree ) |
| - Run `cz bump`. This will | ||
| - Write `CHANGELOG.md` from the commit messages; update the version in `pyproject.toml` | ||
| - Commit `CHANGELOG.md` and `pyproject.toml` | ||
| - Create a new tag |
There was a problem hiding this comment.
Maybe make it clear that tags should be added after the review of the PR.
No description provided.