From d7810850b6849a5d61abc39670edd1e4574d3baa Mon Sep 17 00:00:00 2001 From: Roberto Tyley Date: Wed, 13 Mar 2024 11:09:14 +0000 Subject: [PATCH] Fixup ReadMe for gha-scala-library-release-workflow As well as updating the release instructions to point to the main docs: https://github.com/guardian/gha-scala-library-release-workflow/blob/main/docs/making-a-release.md ...this commit also gets rid of the old BinTray badge, and replaces it with a ScalaDex badge (to list available Scala version support) and a 'Release' workflow badge to link easily to the Release workflow. --- Readme.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/Readme.md b/Readme.md index b3b25f3..a0d19c5 100644 --- a/Readme.md +++ b/Readme.md @@ -1,16 +1,15 @@ # simple-configuration -[ ![Download](https://api.bintray.com/packages/guardian/platforms/simple-configuration-core/images/download.svg) ](https://bintray.com/guardian/platforms/simple-configuration-core/_latestVersion) +[![simple-configuration-core Scala version support](https://index.scala-lang.org/guardian/simple-configuration/simple-configuration-core/latest-by-scala-version.svg?platform=jvm)](https://index.scala-lang.org/guardian/simple-configuration/simple-configuration-core) +[![Release](https://github.com/guardian/simple-configuration/actions/workflows/release.yml/badge.svg)](https://github.com/guardian/simple-configuration/actions/workflows/release.yml) _A configuration library without any magic_ -## Releasing +# Publishing a new release -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). - -[!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. +This repo uses [`gha-scala-library-release-workflow`](https://github.com/guardian/gha-scala-library-release-workflow) +to automate publishing releases (both full & preview releases) - see +[**Making a Release**](https://github.com/guardian/gha-scala-library-release-workflow/blob/main/docs/making-a-release.md). ## Goal This library will help you load the configuration of your application from S3 or the SSM parameter store.