From 65f6cf0b969c15f819c22317dc9a1491bca55dbd Mon Sep 17 00:00:00 2001 From: Ara Cho Date: Wed, 1 May 2024 12:49:59 +0100 Subject: [PATCH 1/2] update readme on the release process and update the badge --- api-models/README.markdown | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/api-models/README.markdown b/api-models/README.markdown index 88c7f0876..502be196d 100644 --- a/api-models/README.markdown +++ b/api-models/README.markdown @@ -80,17 +80,9 @@ For instance: client.send(...).map { case Left(e: CompositeApiError) => ... } ``` ## Releasing the library - -Because of the incompatibility of the play-json module between version 2.3 and 2.4, a different branch has been created. -Each change that has been merged into ````main```` MUST be merged into the ````play-2.4```` branch - -Once this is done, make sure to run ````sbt release```` on both branches +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). # Mobile Notifications API Models -[![Maven Central](https://img.shields.io/maven-metadata/v.svg?label=maven-central&metadataUrl=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Fcom%2Fgu%2Fmobile-notifications-api-models_2.13%2Fmaven-metadata.xml)](https://maven-badges.herokuapp.com/maven-central/com.gu/mobile-notifications-api-models_1.0.16) -[![Project status](https://img.shields.io/badge/status-active-brightgreen.svg)](#status) - -### When to release version changes? -When there's been changes to the model, and a new version of the library has been released in Maven, the `version.sbt` file needs to be updated with the next available version. - -NB: As the main branch is protected, we cannot push directly from main, so we need to do this through a development branch (create a PR). \ No newline at end of file +[![mobile-notifications-api-models Scala version support](https://index.scala-lang.org/guardian/mobile-n10n/mobile-notifications-api-models/latest-by-scala-version.svg?platform=jvm)](https://index.scala-lang.org/guardian/mobile-n10n/mobile-notifications-api-models) \ No newline at end of file From aa00eb11a4144b3831f72942dfeed859b0ee5443 Mon Sep 17 00:00:00 2001 From: Ara Cho Date: Wed, 1 May 2024 12:54:55 +0100 Subject: [PATCH 2/2] remove old badge --- api-models/README.markdown | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/api-models/README.markdown b/api-models/README.markdown index 502be196d..160cab53b 100644 --- a/api-models/README.markdown +++ b/api-models/README.markdown @@ -1,8 +1,5 @@ # Mobile Notifications API Client - -[![Maven Central](https://img.shields.io/maven-central/v/com.gu/mobile-notifications-client_2.11.svg)](https://maven-badges.herokuapp.com/maven-central/com.gu/mobile-notifications-client_2.11) -[![Project status](https://img.shields.io/badge/status-active-brightgreen.svg)](#status) - +[![mobile-notifications-api-models Scala version support](https://index.scala-lang.org/guardian/mobile-n10n/mobile-notifications-api-models/latest-by-scala-version.svg?platform=jvm)](https://index.scala-lang.org/guardian/mobile-n10n/mobile-notifications-api-models) Scala client for the Guardian Mobile Notifications API. ## Integrating with your application @@ -82,7 +79,4 @@ client.send(...).map { case Left(e: CompositeApiError) => ... } ## Releasing the library 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). - -# Mobile Notifications API Models -[![mobile-notifications-api-models Scala version support](https://index.scala-lang.org/guardian/mobile-n10n/mobile-notifications-api-models/latest-by-scala-version.svg?platform=jvm)](https://index.scala-lang.org/guardian/mobile-n10n/mobile-notifications-api-models) \ No newline at end of file +[**Making a Release**](https://github.com/guardian/gha-scala-library-release-workflow/blob/main/docs/making-a-release.md). \ No newline at end of file