diff --git a/RELEASING.md b/RELEASING.md index 03b05ff..edc2d4e 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -7,8 +7,13 @@ release using this tool for this repository. ## Start a release -First, decide which module sets will have their versions changed and what those -versions will be. +1. Find out which modules were changed since the last release. +2. Decide the new version of each of those modules, following semantic versioning +3. Look at the dependency graph from the [README](./README.md) and also bump the bugfix version part of all the modules that depend on the previously identified modules + +For example, if you created a new feature in `x/events` and in `logger`, you would increase the +minor version of those 2 modules and also increase the bugfix versions of +`otel`, `camunda` and `middleware` as those 3 are depending on the other 2. ### Create a release branch @@ -23,6 +28,8 @@ Set the version for all the module sets you have identified to be released. make prerelease MODSET= ``` +where `` is something like `logger` or `xevents` for example. + This will use `multimod` to upgrade the module's versions and create a new "prerelease" branch for the changes. Verify the changes that were made. @@ -37,23 +44,6 @@ it into your release branch. git merge prerelease__ ``` -### Update the CHANGELOG.md - -Update the [Changelog](./CHANGELOG.md). Make sure only changes relevant to this -release are included and the changes are communicated in language that -non-contributors to the project can understand. - -Double check there is no change missing by looking directly at the commits -since the last release tag. - -```sh -git --no-pager log --pretty=oneline "..HEAD" -``` - -Be sure to update all the appropriate links at the bottom of the file. - -Finally, commit this change to your release branch. - ### Make a Pull Request Push your release branch and create a pull request for the changes. Be sure to @@ -95,4 +85,4 @@ Finally create a Release on GitHub. If you are releasing multiple versions for different module sets, be sure to use the stable release tag but be sure to include each version in the release title (i.e. `Release v1.0.0/v0.25.0`). The release body should include all the curated changes from the Changelog for this -release. \ No newline at end of file +release. diff --git a/camunda/v2/go.mod b/camunda/v2/go.mod index cb833a8..f79faee 100644 --- a/camunda/v2/go.mod +++ b/camunda/v2/go.mod @@ -9,7 +9,7 @@ replace ( ) require ( - github.com/blacklane/go-libs/logger v0.6.5 + github.com/blacklane/go-libs/logger v0.7.0 github.com/google/uuid v1.3.0 github.com/stretchr/testify v1.7.1 ) diff --git a/logger/go.mod b/logger/go.mod index 5ecb086..19117bc 100644 --- a/logger/go.mod +++ b/logger/go.mod @@ -9,7 +9,7 @@ replace ( require ( github.com/blacklane/go-libs/tracking v0.3.1 - github.com/blacklane/go-libs/x/events v0.3.0 + github.com/blacklane/go-libs/x/events v0.4.0 github.com/google/go-cmp v0.5.7 github.com/rs/zerolog v1.26.0 github.com/stretchr/testify v1.7.1 diff --git a/middleware/go.mod b/middleware/go.mod index abee983..e6f8bbb 100644 --- a/middleware/go.mod +++ b/middleware/go.mod @@ -11,11 +11,11 @@ replace ( ) require ( - github.com/blacklane/go-libs/camunda/v2 v2.0.4 - github.com/blacklane/go-libs/logger v0.6.5 - github.com/blacklane/go-libs/otel v0.1.4 + github.com/blacklane/go-libs/camunda/v2 v2.0.5 + github.com/blacklane/go-libs/logger v0.7.0 + github.com/blacklane/go-libs/otel v0.1.5 github.com/blacklane/go-libs/tracking v0.3.1 - github.com/blacklane/go-libs/x/events v0.3.0 + github.com/blacklane/go-libs/x/events v0.4.0 github.com/google/go-cmp v0.5.7 github.com/google/uuid v1.3.0 github.com/stretchr/testify v1.7.1 diff --git a/otel/go.mod b/otel/go.mod index a38155d..3f15b3b 100644 --- a/otel/go.mod +++ b/otel/go.mod @@ -9,9 +9,9 @@ replace ( ) require ( - github.com/blacklane/go-libs/logger v0.6.5 + github.com/blacklane/go-libs/logger v0.7.0 github.com/blacklane/go-libs/tracking v0.3.1 - github.com/blacklane/go-libs/x/events v0.3.0 + github.com/blacklane/go-libs/x/events v0.4.0 github.com/rs/zerolog v1.26.0 go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.32.0 go.opentelemetry.io/otel v1.7.0 diff --git a/versions.yaml b/versions.yaml index e961771..ac9164e 100644 --- a/versions.yaml +++ b/versions.yaml @@ -1,18 +1,18 @@ module-sets: camunda: - version: v2.0.4 + version: v2.0.5 modules: - github.com/blacklane/go-libs/camunda/v2 logger: - version: v0.6.5 + version: v0.7.0 modules: - github.com/blacklane/go-libs/logger middleware: - version: v0.3.4 + version: v0.3.5 modules: - github.com/blacklane/go-libs/middleware otel: - version: v0.1.4 + version: v0.1.5 modules: - github.com/blacklane/go-libs/otel probes: @@ -24,7 +24,7 @@ module-sets: modules: - github.com/blacklane/go-libs/tracking xevents: - version: v0.3.0 + version: v0.4.0 modules: - github.com/blacklane/go-libs/x/events excluded-modules: