-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #63 from kafkesc/detro/52-intro_changelog
Add `CHANGELOG.md` + badges to `README.md`
- Loading branch information
Showing
3 changed files
with
93 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# vNEXT (2023-??-??) | ||
|
||
## Notes | ||
|
||
* Introduced (this) [`CHANGELOG.md`](./CHANGELOG.md) and accompanying [`CHANGELOG_GUIDANCE.md`](./CHANGELOG_GUIDANCE.md) (#52) | ||
* Added build badges to [`README.md`](./README.md) (#62) | ||
|
||
# v0.2.0 (2023-09-24) | ||
|
||
## Enhancements | ||
|
||
* Refined logging to avoid polluting logs with temporary startup-time issues (i.e. not enough offset or lag info yet to produce estimations) | ||
* `partition_offsets` module: Increased frequency of fetch of offset watermark | ||
* New CLI argument `--history-ready-at` | ||
|
||
## Breaking changes | ||
|
||
* Separated the arguments to define `--host` and `--port` to listen on | ||
|
||
## Notes | ||
|
||
* Multiple dependencies upgrade | ||
|
||
# v0.1.x (2023-08) | ||
|
||
## Features | ||
|
||
* First fully working release | ||
* Production of multiple lag metrics: | ||
* Consumer Metrics | ||
* `kmtd_kafka_consumer_partition_lag_milliseconds` | ||
* `kmtd_kafka_consumer_partition_lag_offset` | ||
* `kmtd_kafka_consumer_partition_offset` | ||
* Topic Partition Metrics | ||
* `kmtd_kafka_partition_earliest_available_offset` | ||
* `kmtd_kafka_partition_latest_available_offset` | ||
* Topic Partition Offset Tracking Metrics | ||
* `kmtd_kafka_partition_earliest_tracked_offset` | ||
* `kmtd_kafka_partition_latest_tracked_offset` | ||
|
||
## Enhancements | ||
|
||
* Documented all exported metrics in [`METRICS.md`](./METRICS.md) | ||
* Setup CI automation and automatic publishing when commit `vX.Y.Z` is pushed |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# `CHANGELOG.md` Guidance | ||
|
||
At this stage, we manage the changelog manually. Nothing fancy. | ||
|
||
Each entry has to match a release, and follow this format: | ||
|
||
```markdown | ||
# vMAJOR.MINOR.PATCH (20??-??-??) | ||
|
||
## Breaking Changes | ||
|
||
## Features | ||
|
||
## Enhancements | ||
|
||
## Bug Fixes | ||
|
||
## Notes | ||
``` | ||
|
||
The `# H1` should be `version (ISO DATE)`. | ||
|
||
The `## H2` are instead categories of what we want to report about this version. | ||
**IMPORTANT:** Before cutting the release, remove any section that is empty for the given release: no point | ||
in publishing empty sections. | ||
|
||
## Categorization | ||
|
||
Information in each entry should be structured as follows: | ||
|
||
`## Breaking Changes`: This section documents in brief any incompatible changes and how to handle them. | ||
**This should only be present in major (or, in some cases, minor) version upgrades**. | ||
|
||
`## Features`: These are new improvements and features that deserve to be highlighted. | ||
**This should be marked by a minor version upgrade**. | ||
|
||
`## Enhancements`: Smaller features added to the project. | ||
|
||
`## Bug Fixes`: Any bugs that were fixed. | ||
|
||
`## Notes`: Additional information for potentially unexpected upgrade behavior, notice of upcoming deprecations, | ||
or anything worth highlighting to the user that does not fit in the other categories. | ||
**This should not be abused**: always consider if the information is of any material importance to the user. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters