Skip to content

Commit

Permalink
Merge pull request #1226 from guardian/update-readme-on-new-release-p…
Browse files Browse the repository at this point in the history
…rocess

update readme on the release process and update the badge
  • Loading branch information
aracho1 authored May 1, 2024
2 parents cd86b61 + aa00eb1 commit 445977f
Showing 1 changed file with 4 additions and 18 deletions.
22 changes: 4 additions & 18 deletions api-models/README.markdown
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -80,17 +77,6 @@ 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

# 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).
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).

0 comments on commit 445977f

Please sign in to comment.