diff --git a/README.md b/README.md index 0b4ba36..466970a 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,37 @@ In your build.sbt: libraryDependencies += "com.gu" %% "hmac-headers" % "" // find the latest version by checking this repo's tags ``` +## Releasing + +### Testing locally + +You can publish locally by running: + +```shell +# Test your signing setup works (you may need to follow the guide below first) +sbt +publishLocalSigned + +# Publish locally so that other projects can use your local ivy repository +sbt +publishLocal +``` + +### Get access to publish +You will need to have access to publish to Maven Central for `com.gu` assets. +You can [follow this guide](https://docs.google.com/document/d/1rNXjoZDqZMsQblOVXPAIIOMWuwUKe3KzTCttuqS7AcY/edit#heading=h.651termw35o0) +to get access. + +### Update the version +When you are ready to release, ensure that [`version.sbt`](./version.sbt) is updated and committed in the default branch +(`main`) with an appropriate version bump following [`semver`](https://semver.org/). + +### Tag and release + +This will create & push the appropriate version tag for you: + +```shell +sbt release +```` + ## Verifying requests ``` diff --git a/version.sbt b/version.sbt index 7914ee9..106e757 100644 --- a/version.sbt +++ b/version.sbt @@ -1 +1 @@ -ThisBuild / version := "1.2.0" +ThisBuild / version := "2.0.0-SNAPSHOT"