README.md in gitlab-labkit-0.9.1 vs README.md in gitlab-labkit-0.10.0

- old
+ new

@@ -16,11 +16,12 @@ ## Functionality LabKit-Ruby provides functionality in three areas: -1. `Labkit::Correlation` for handling and propagating Correlation-IDs. +1. `Labkit::Context` used for providing context information to log messages. +1. `Labkit::Correlation` For accessing the correlation id. (Generated and propagated by `Labkit::Context`) 1. `Labkit::Logging` for sanitizing log messages. 1. `Labkit::Tracing` for handling and propagating distributed traces. ## Developing @@ -39,5 +40,18 @@ ``` Note that LabKit-Ruby uses the [`rufo`](https://github.com/ruby-formatter/rufo) for auto-formatting. Please run `bundle exec rake fix` to auto-format your code before pushing. Please also review the [development section of the LabKit (go) README](https://gitlab.com/gitlab-org/labkit#developing-labkit) for details of the LabKit architectural philosophy. + +### Releasing a new version + +Releasing a new version can be done by pushing a new tag, or creating +it from the +[interface](https://gitlab.com/gitlab-org/labkit-ruby/-/tags). + +A new changelog will automatically be added to the release on Gitlab. + +The new version will automatically be published to +[rubygems](https://rubygems.org/gems/gitlab-labkit) when the pipeline +for the tag completes. It might take a few minutes before the update +is available.