diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..bcd5970 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,26 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +## [0.0.2] - 2023-07-10 + +### Added + +- CNIL mention (#18) +- Customized logging on module level (#19) + +### Fixed + +- Pre-commit errors (#19) + + +## [0.0.1] - 2023-04-24 + +### Added + +- Initial release diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7626bf9..9d57a8e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,31 @@ ### Building the new version -Increment the version in `pyproject.toml`. +1. Increment the version in `pyproject.toml`. + +1. Update the `CHANGELOG.md`. + + - Follow [the guidelines](https://keepachangelog.com/) + - Rename `Unreleased` section to the new version + - Create a new empty `Unreleased` section + +1. Create a PR with the title `Release [version]`, ask for a review. + +1. Publish the package to Test PyPi and verify that it's working correctly + (the instructions are below). + +1. Merge the PR. + +1. [Create new release](https://github.com/statice/anonymeter/releases/new) + in github + + - specify the new tag which equals to the new `[version]` + - copy paste the new release notes from the `CHANGELOG.md` + + +### Publishing to Test PyPi + +Don't forget to pull the latest `main`. Install development dependencies: ```bash @@ -17,8 +41,6 @@ rm -rf ./dist # clean the build directory if necessary python -m build ``` -### Publishing to Test Pypi - Login to Test PyPi. Create a new account if you don't have it yet and ask to be added as a collaborator for Anonymeter. @@ -60,6 +82,8 @@ python -m pytest Once you tested the package with Test PyPi, you're ready to publish to the original PyPi. +Pull the latest `main` and build the package as described above. + Login to PyPi. Create a new account if you don't have it yet and ask to be added as a collaborator for Anonymeter. @@ -75,15 +99,3 @@ Upload the artifacts to PyPi: ```bash twine upload dist/* ``` - -### Publish the new release to GitHub - -Commit the version update: - -```bash -git commit -m "Version bump -> NEW_VERSION" pyproject.toml -``` - -Tag the source: `git tag NEW_VERSION`. - -Push commit and tag: `git push --tags origin main`. diff --git a/pyproject.toml b/pyproject.toml index 38fbf44..86e6597 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta" [project] name = "anonymeter" -version = "0.0.1" +version = "0.0.2" authors = [ { name="Statice GmbH", email="hello@statice.ai" }, ] @@ -62,6 +62,7 @@ dev = [ [project.urls] "Homepage" = "https://github.com/statice/anonymeter" "Bug Tracker" = "https://github.com/statice/anonymeter/issues" +"Changelog" = "https://github.com/statice/anonymeter/blob/main/CHANGELOG.md" [tool.isort] profile = "black"