Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release/0.1.0 #20

Closed
wants to merge 2 commits into from
Closed

Release/0.1.0 #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3cfd56
feat: use commitizen (#19)
cmp0xff Mar 10, 2024
39fb0c7
bump: version 0.0.1 → 0.1.0
cmp0xff Mar 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## 0.1.0 (2024-03-10)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


### Feat

- use commitizen (#19)
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
# hamilflow

Dataset of simple physical systems.

## Publish process
- 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 )
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

indeed -b is required

- 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
Copy link
Member

@emptymalei emptymalei Mar 11, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe make it clear that tags should be added after the review of the PR.

- Push to `release/X.Y.Z`
- Merge to `main`, no need to squash, maybe don't delete the branch under release
Loading
Loading