Skip to content

feat(ops): #18 use commitizen #21

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

Merged
merged 5 commits into from
Mar 13, 2024
Merged

feat(ops): #18 use commitizen #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e3cfd56
feat: use commitizen (#19)
cmp0xff Mar 10, 2024
11e2429
feat(commitizen): changelog path
cmp0xff Mar 12, 2024
32181ea
doc(commitizen): #18 update instruction
cmp0xff Mar 12, 2024
8d473cd
chore(poetry): #18 🔒
cmp0xff Mar 12, 2024
2498f95
chore(doc): #18 -b
cmp0xff Mar 12, 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
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
# hamilflow

Dataset of simple physical systems.

## Publish process

- Squash merge all features to `main`
- 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 -b release/X.Y.Z`
- Run `cz bump`. This will
- Write `docs/changelog.md` from the commit messages; update the version in `pyproject.toml`
- Commit `docs/changelog.md` and `pyproject.toml`
- Create a new tag
- Push to `release/X.Y.Z`
- Merge to `main`, no need to squash, maybe don't delete the branch under release
Loading