Update build and include sbt publish GHA workflow #193
Conversation
|
build.sbt
Outdated
| @@ -19,21 +22,12 @@ inThisBuild(Seq( | |||
| scalacOptions ++= Seq( | |||
| "-deprecation", | |||
| "-Xfatal-warnings", | |||
| "-encoding", "UTF-8" | |||
| "-encoding", "UTF-8", | |||
| "-release:11", | |||
| ), | |||
| // sonatype metadata | |||
| organization := "com.gu", | |||
| licenses := Seq("Apache V2" -> url("https://www.apache.org/licenses/LICENSE-2.0.html")), | |||
There was a problem hiding this comment.
This can be tweaked to:
| licenses := Seq("Apache V2" -> url("https://www.apache.org/licenses/LICENSE-2.0.html")), | |
| licenses := Seq(License.Apache2), |
There was a problem hiding this comment.
Yeah thanks, might as well update that now as well 👍
| @@ -0,0 +1,13 @@ | |||
| name: Release Scala client | |||
There was a problem hiding this comment.
Just by convention, this file is called release.yml in all the other repos that have gha-scala-library-release-workflow - would it be ok to rename this file to match?
There was a problem hiding this comment.
The trouble is that this repo has a node client and a Scala client. I didn't want the workflow to give the impression it would do both. Let me know if you feel super strongly, but I don't think hogging the word "release" in the workflow namespace is always a good idea!
There was a problem hiding this comment.
That makes sense - what we've actually done with other libraries that publish both NPM & Scala packages is that we've tied them together in a single release workflow (at which point, it's kind of ok to just call it release.yml again). We allow the NPM release to utilise the Scala libraries version number, so that their releases are synchronised and it's easy to see whether the NPM and Scala libraries are from the same point in time.
We've done this for:
- Adopt GHA-Scala-Library-Release-Workflow content-api-models#232
- Adopt gha-scala-library-release process content-entity#32
- Adopt gha-scala-rel-workflow in the project content-atom#166
These libraries where largely completely defined by their thrift definitions, so if one library wanted to change, the other did too. This might not be the case with anghammarad, so it might not apply here, but it is quite nice to just have one button to press.
There was a problem hiding this comment.
Ok makes sense! I'll rename it and we can consider unifying these libraries in the future.
Sets up Anghammarad to use the sbt publish GHA workflow, removing redundant publishing plugins for sbt and eliminating sbt config options that are no longer required. We also include the workflow file itself, taken from the docs. https://github.com/guardian/gha-scala-library-release-workflow/blob/main/docs/configuration.md
adamnfish
force-pushed
the
migrate-to-sbt-release-workflow
branch
from
7be0261 to
e97c536
Compare
This repository contains an npm client library as well as the scala client. Despite this, we're best off creating a single "release" workflow and if we want to automate the npm flow we can have it be called from this single release workflow.
Improve the documentation of the release workflow Co-authored-by: Roberto Tyley <[email protected]>
What does this change?
Sets up Anghammarad to use the sbt publish GHA workflow, removing redundant publishing plugins for sbt and eliminating sbt config options that are no longer required.
We also include the workflow file itself, taken from the docs.
https://github.com/guardian/gha-scala-library-release-workflow/blob/main/docs/configuration.md
How to test
We'll hit the "release" button once this (and dependent infrastructure*) is merged.