Release prep (#208)

* minor version bump

* update CHANGELOG.md

* improve breaking changes section in CHANGELOG.md

* update breaking change message for consume

* add more info to CHANGELOG.md

* typo fix

* try fixing testpypi publish step

* try again

* and again

.github/workflows/release-prep.yml

@@ -77,8 +77,8 @@ jobs:
         if: success()
         run: |
           VERSION=$(sed -n -E "s/^version = \"(.+)\"/\1/p" pyproject.toml)
-          git fetch origin master:master
-          BUILD=$(git rev-list --count HEAD...master)
+          # turn the hash into a 3-digit decimal number
+          BUILD=$(( $(git log -1 --format='16#%h') % 1000))
           sed -i -E "s/^version = .*/version = \"${VERSION}.dev${BUILD}\"/" pyproject.toml
           poetry build
           poetry publish --repository testpypi

CHANGELOG.md

@@ -1,11 +1,36 @@
+### Version 0.4.0
+* Introduced new `io` module to replace old consumer logic
+* Restructured the `cli.commands` module into sub packages/modules for better overview
+* Removed old client/consumer logic
+* Lazily instantiate admin clients to improve responsiveness of some commands
+* Reintroduced the `esque transfer` command to transfer data from one topic to another
+* Added the `esque io` command for more advanced use cases that are not covered by the options provided with the 
+  `esque consume`, `esque produce` and `esque transfer` commands.
+* Added more information to `esque create topic` to show you what will be created before you approve it.
+* Added more information to `esque ping` to also show timings from client to server and from server to client.
+
+#### Breaking changes
+`esque consume --avro --stdout` now json serializes the avro data into the message key and value objects which in turn 
+are always strings. Therefore, attributes of key or value objects will not be directly accessible on the root structure.
+However, as a workaround, you could for example pipe the data through `jq '.key | fromjson'` to decode the json objects 
+again.
+
+`esque ping` now does not create a new topic all the time but uses a topic called `esque-ping` with random message 
+key to distinguish ping messages from different users.
+
+The files and file structure in the directories that were created by `esque consume` and required by `esque produce` 
+has changed. Directories that were previously created with `esque consume` won't work with `esque produce` anymore.
+
 ### Version 0.3.1
 * Added the `delete topics` command that enables deleting more than one topic
 * Modified the existing `delete topic` command to accept only a single topic entry
 * Refactored the topic deletion logic to improve performance
+
 ### Version 0.3.0
 * Remove pykafka dependency
 * Include a partial fix for #32 (topics are now displayed, output is still not optimal)
 * Minor performance improvements
+
 ### Version 0.2.10
 * Bugfix for issue #175
 * Do not fail silently upon offset commit error
@@ -14,41 +39,54 @@
 * Running esque now creates a cProfiler snapshot when the environment variable `ESQUE_PROFILE` is set to a non-empty 
   value
 * Fix issue with decimal values from avro not being properly displayed in stdout
+
 ### Version 0.2.9
 * Added `--binary` flag to `produce` and `consume`
+
 ### Version 0.2.8
 * Updated avro-python3 to version 1.10.0
+
 ### Version 0.2.7
 * Exit with code 1 when `apply` tries to change the number of partitions or the replication factor for a topic.
+
 ### Version 0.2.6
 * Enabled listing internal topics by default. Added `--hide-internal` flag to `get topics` command.
+
 ### Version 0.2.5
 * Enable support for variadic arguments when deleting topics and consumer groups.
 * Enable piping in arguments when deleting topics and consumer groups.
+
 ### Version 0.2.4
 * Add `delete consumergroup` command.
+
 ### Version 0.2.3
 * Converted unserializable values to strings when writing to STDOUT
+
 ### Version 0.2.2
 * Consume option renamed from `numbers` to `number`.
 * Add `edit offsets` command.
 * Bugfix for `OverflowError` in `pretty_duration` function.
 * use `esque-client` as default group id for all esque commands
 * disable group offset commits for ping, consume and describe
+
 ### Version 0.2.1
 * Bugfix for issue #154
+
 ### Version 0.2.0
 * Bugfix for issue #149
+
 ### Version 0.2.0b3
 * Bugfix #136: Fix wrong schema version for null payload
 * Enhancement #141: Split folder for key and value schema when consuming messages
 * Fix for issue #46: apply command doesn't consider cluster defaults when settings are changed
 * Fix for issue #132: getting information about internal topics is not possible
 * Fix for issue #143: Consume sometimes finishes successfully without writing any messages
+
 ### Version 0.2.0b2
 * Enhancement #129: use offsets_for_times to set consumer group offsets
  to specific point in time
 * Fix for issue #125: esque was often throwing MessageEmptyException's when operating on topics with empty partitions.
+
 ### Version 0.2.0b0
 * Moved the CI workflow to GitHub Actions
 * Command `edit consumergroup` renamed to `set offsets`

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "esque"
-version = "0.3.1"
+version = "0.4.0"
 description="esque - an operational kafka tool."
 authors = ["real.digital <[email protected]>"]
 license = "MIT"