Skip to content

Commit

Permalink
docs: Update README with updated info about releasing
Browse files Browse the repository at this point in the history
  • Loading branch information
tjsilver committed Aug 4, 2023
1 parent 20a152f commit 18a6423
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ _A configuration library without any magic_
## Releasing

Run `sbt release` at the root to publish the artifacts to sonatype. For instructions on how to set up publishing, visit [this doc](https://docs.google.com/document/d/1rNXjoZDqZMsQblOVXPAIIOMWuwUKe3KzTCttuqS7AcY/edit).
Once the release is complete, push the automated commit to `main` which updated `version.sbt` as part of the release process.

[!IMPORTANT]
For some reason, releases are not promoted from staging, so you will need to do this manually if you notice your package sitting in [staging](https://oss.sonatype.org/#stagingRepositories). First 'close' the staged package, then choose 'release' and this will promote it to Maven.
Our investigations imply that the `releaseStepCommand("sonatypeBundleRelease")` step is not running during release, but this has not been fully investigated for time reasons.

## Goal
This library will help you load the configuration of your application from S3 or the SSM parameter store.
Expand Down

0 comments on commit 18a6423

Please sign in to comment.