chore(release): Generate changelog (#26)

* chore(release): Generate changelog

Integrate [commitizen](https://commitizen-tools.github.io/commitizen/)
to automatically generate the changelog and create a tag for release.

Signed-off-by: Charith Ellawala <charith@cerbos.dev>

* Show detailed changes

Signed-off-by: Charith Ellawala <charith@cerbos.dev>

* Remove changelog check

Signed-off-by: Charith Ellawala <charith@cerbos.dev>

* Add changelog check

Signed-off-by: Charith Ellawala <charith@cerbos.dev>

---------

Signed-off-by: Charith Ellawala <charith@cerbos.dev>

.github/workflows/pr.yaml

@@ -12,6 +12,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
       - uses: actions/cache@v3
         with:
@@ -28,12 +30,16 @@ jobs:
       - name: Format
         run: ./pw format
 
+      - name: Generate changelog
+        run: ./pw changelog
+
       - name: Check repo status
         run: |-
           REPO_STATUS="$(git status --porcelain)"
           if [[ ! -z $REPO_STATUS ]]; then
             echo "::error::Uncommitted changes detected"
             echo "$REPO_STATUS"
+            git status -vv
             exit 1
           fi
 

CHANGELOG.md

@@ -0,0 +1,62 @@
+## Unreleased
+
+## v0.7.1 (2023-06-07)
+
+### Enhancements
+
+- Add support for new `outputs` field in `CheckResources` return (#24)
+
+## v0.6.0 (2023-05-02)
+
+### Enhancements
+
+- Make testcontainers optional (#22)
+
+## v0.5.0 (2023-01-03)
+
+## v0.4.1 (2022-08-24)
+
+### Bug fixes
+
+- Handle `raise_on_error` correctly in async client (#17)
+
+## v0.4.0 (2022-07-25)
+
+### Bug fixes
+
+- Decode PlanResources response into correct types (#15)
+
+### Features
+
+- Async support (#13)
+
+## v0.3.1 (2022-07-08)
+
+### Bug fixes
+
+- Remove importlib (#11)
+
+## v0.3.0 (2022-07-01)
+
+### Enhancements
+
+- Add validation errors to PlanResources (#8)
+
+## v0.2.0 (2022-06-03)
+
+### Documentation
+
+- Fix import statement in README example (#3)
+- Update README
+
+### Enhancements
+
+- Add support for Unix domain sockets (#6)
+
+## v0.1.0 (2022-05-02)
+
+### Chores
+
+- Use stable plan API
+- Disable telemetry in CI
+- Add release metadata

DEVELOPMENT.md

@@ -39,15 +39,18 @@ Running a REPL
 ./pw pdm run python
 ```
 
-Publishing to PyPI
+### Releases
+
+- Run `./pw tag_release PATCH` to generate the changelog and tag the release. (Replace `PATCH` with `MINOR` if you are incrementing the minor version.)
+- Push the new tag to GitHub to launch the CI release job
+
+
+#### Publishing to Test PyPI
 
 ```shell
 ./pw pdm build
 
 # Test PyPI
 ./pw twine upload -r testpypi dist/*
-
-# PyPI
-./pw twine upload dist/*
 ```