📝 Document how to release (#36)

* Document how to do a release

* Update CHANGELOG to exclude commits

Old entries _mainly_ list the Pull Requests

CHANGELOG.md

@@ -12,9 +12,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Allow dequeueing a job without side-effects [`#33`](https://github.com/valohai/minique/pull/33)
 - 🪠🐛 Use the instantiated Redis pipeline on job cancel [`#34`](https://github.com/valohai/minique/pull/34)
 - 🌱🧹 Spring cleaning [`#32`](https://github.com/valohai/minique/pull/32)
-- Allow storing jobs without queueing them [`a64bbac`](https://github.com/valohai/minique/commit/a64bbac2df735fe699163aaff18ddf66c3e95060)
-- Replace Black with Ruff format [`cd9d5a2`](https://github.com/valohai/minique/commit/cd9d5a227024c1443665a50a7d74193b698f22b6)
-- Document `enqueue` [`1337cf2`](https://github.com/valohai/minique/commit/1337cf299982ef0b68a22ba728c53f9b00d98cfe)
 
 #### [v0.8.0](https://github.com/valohai/minique/compare/v0.7.0...v0.8.0)
 

README.md

@@ -43,8 +43,8 @@ job = get_job(redis, job_id)
 
 - Ensure your workers are able to import the functions you wish to run.
 - Set the callables the worker will allow with `--allow-callable`.
-  - Alternately, you may wish to subclass `minique.work.job_runner.JobRunner`
-    to specify an entirely different lookup mechanism.
+    - Alternately, you may wish to subclass `minique.work.job_runner.JobRunner`
+      to specify an entirely different lookup mechanism.
 
 ```bash
 $ minique -u redis://localhost:6379/4 -q work -q anotherqueue -q thirdqueue --allow-callable 'my_jobs.*'
@@ -64,8 +64,8 @@ you should see a "Sentry configured with a valid DSN" message at CLI boot.
 The [other environment-configurable options](https://docs.sentry.io/platforms/python/configuration/options/)
 also work as you would expect.
 
-Exceptions occurring during job execution will be sent to Sentry and annotated with `minique` context
-describing the job ID and queue name.
+Exceptions occurring during job execution will be sent to Sentry and annotated with `minique`
+context describing the job ID and queue name.
 
 ### Development
 
@@ -83,5 +83,22 @@ mypy --strict --install-types --show-error-codes minique
 REDIS_URL=redis://localhost:6379/0 pytest .
 ```
 
+### Release
+
+```shell
+# decide on a new version number and set it
+vim minique/__init__.py
+__version__ = "0.9.0"
+
+npx auto-changelog --commit-limit=0 -v 0.9.0
+
+# undo changes changelog generation did to the older entries
+
+git add -u
+git commit -m "Become 0.9.0"
+git tag -m "v0.9.0" -a v0.9.0
+
+git push --follow-tags
+```
 
 [extras]: https://packaging.python.org/tutorials/installing-packages/#installing-setuptools-extras