Commit 99afea46 authored by Bob Van Landuyt's avatar Bob Van Landuyt 💬
Browse files

Add `Labkit::Context` to the readme 

And update how `Labkit::Correlation` relates to the context
parent 629ed491

README.md

+15 −1
Original line number Diff line number Diff line
@@ -18,7 +18,8 @@ The changelog is available via [**tagged release notes**](https://gitlab.com/git 


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.
@@ -41,3 +42,16 @@ $ bundle exec rake verify 
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.