Implement gha-scala-library-release-workflow release process. #402

Divs-B · 2024-01-12T12:42:47Z

What does this change?

This Library had GHA recently but now introducing more secured, less code and easy deployable way of automised workflow that is gha-scala-library-release-workflow

ref:https://github.com/guardian/gha-scala-library-release-workflow/blob/main/docs/configuration.md

How to test

Tests are passing locally.

Need to test further by releasing snapshot release once the PR is reviewed, finalised and merged.

rtyley

Note that you will need to fix version.sbt in this PR as well, as it's currently out of date - there has already been release 20.0.0, but they forgot to update version.sbt to reflect that...!

content-api-scala-client/version.sbt

Line 1 in ed01efc

ThisBuild / version := "19.4.2-SNAPSHOT"

Divs-B · 2024-01-12T16:24:35Z

Thanks for letting me know @rtyley , I will update version.sbt with latest version.

rtyley · 2024-01-12T16:05:58Z

build.sbt

+    Compile / sources := Seq.empty,
+    Test / sources := Seq.empty,


I'm fairly sure these two lines can be deleted too!

Suggested change

Compile / sources := Seq.empty,

Test / sources := Seq.empty,

rtyley · 2024-01-12T16:11:29Z

build.sbt

+      checkSnapshotDependencies,
+      inquireVersions,
+      runClean,
+      runTest,


I'm afraid you'll need to remove runTest for the time being, as, like in the facia-scala-client PR, the content-api-scala-client tests require an additional credential (CAPI_TEST_KEY) that is difficult to pass down through the reusuable release workflow.

Suggested change

runTest,

rtyley · 2024-01-12T16:21:11Z

project/Metadata.scala

+//
+//  val awsDevs =
+//    List( Developer(id="tomrf1", name="Tom Forbes", email="", url=url("https://github.com/tomrf1"))
+//        )


It turns out this entire file (Metadata.scala) can be deleted!

It's full of metadata that is only for serving the Maven Central metadata requirements - but that information is now provided by gha-scala-library-release-workflow in this one line! (guardian/gha-scala-library-release-workflow#4 has a little more info about this)

The only 2 bits that are still needed are:

licenses := Seq(License.Apache2) - can move up into the artifact-generating modules in build.sbt

val ghProject = "content-api-client" - can just be up near the top of build.sbt

...but apart from that, anything that's using the Metadata class in build.sbt just needs to drop the reference to it.

fair point 👍

rtyley · 2024-01-12T16:26:47Z

project/Dependencies.scala

@@ -1,7 +1,7 @@
 import sbt._

 object Dependencies {
-  val scalaVersions = Seq("2.12.10", "2.13.1")
+  val scalaVersions = Seq("2.12.17", "2.13.12")


There's a slightly newer version of Scala 2.12 we can use!

Suggested change

val scalaVersions = Seq("2.12.17", "2.13.12")

val scalaVersions = Seq("2.12.18", "2.13.12")

rtyley · 2024-01-12T16:28:41Z

version.sbt

@@ -1 +1 @@
-ThisBuild / version := "19.4.2-SNAPSHOT"
+ThisBuild / version := "20.0.1-SNAPSHOT"


Perfect! Yep, this is good, we've already had release 20.0.0 so now we need to be setting ourselves up for 20.0.1!

rtyley · 2024-01-12T16:52:06Z

build.sbt

 // we apply versionSettingsMaybe to aws too because this project is always released in isolation
 // from the others - and we _might_ want to put out a snapshot or beta for that (TBC).
 // Bear this in mind if we begin releasing aws in sync with the others


Note that we should delete this comment too, as part of this PR, because it talks about versionSettingsMaybe, and we're deleting that on the line below.

Suggested change

// we apply versionSettingsMaybe to aws too because this project is always released in isolation

// from the others - and we _might_ want to put out a snapshot or beta for that (TBC).

// Bear this in mind if we begin releasing aws in sync with the others

// we apply versionSettingsMaybe to aws too because this project is always released in isolation

// from the others - and we _might_ want to put out a snapshot or beta for that (TBC).

// Bear this in mind if we begin releasing aws in sync with the others

The comment was added with PR #324, and it makes an interesting point - that there essentially two separate groups of libraries in this repository, and they don't actually depend on each other - content-api-client-aws doesn't depend on content-api-client, content-api-client-default, etc, and they don't depend on it. They have different version numbers (content-api-client-aws is only at version 0.7), and I think this leaves us with two possible courses of action, which we need to choose from:

Synchronise them up and release them together, sharing a version number

Separate content-api-client-aws out into its own GitHub repository, and have a separate release setup for that - right now, I think this is the one that makes most sense to me.

The reason for extracting the `aws` project is that it is not dependent on `content-api-scala-client` and was also released separately in the past, so it has different version numbers. further reference is here: #402 (comment) ref:https://github.com/guardian/content-api-client-aws

ref:https://github.com/guardian/gha-scala-library-release-workflow/blob/main/docs/configuration.md

rtyley · 2024-01-17T16:55:50Z

build.sbt

-  javacOptions            ++= Seq("-source", "1.8", "-target", "1.8"),
-  scalacOptions           ++= Seq("-deprecation", "-unchecked"),
+  scalacOptions           ++= Seq("-deprecation", "-unchecked", "-release:8"),


Using -release:8 will include setting "-target", "1.8" for the Java compiler, and we don't need "-source", "1.8" as we are not using any Java source files!

rtyley

Nice work!

Divs-B · 2024-01-17T16:57:25Z

Thanks @rtyley for pairing and all help.

This will fix the release process which was failing because it was searching for artifact group id. Error ref:https://github.com/guardian/content-api-scala-client/actions/runs/7559137372/job/20582282903#step:4:211 We forgot these settings in prev PR: #402

This follows on from #402.

rtyley mentioned this pull request Jan 12, 2024

Adoption of gha-scala-library-release-workflow across the Guardian guardian/gha-scala-library-release-workflow#20

Open

rtyley reviewed Jan 12, 2024

View reviewed changes

Divs-B mentioned this pull request Jan 17, 2024

The AWS project is removed after having it as a standalone library #403

Merged

Divs-B added 3 commits January 17, 2024 16:36

Implemented gha-scala-library-release-workflow release process.

94f779b

ref:https://github.com/guardian/gha-scala-library-release-workflow/blob/main/docs/configuration.md

Snapshot version updated

7fd7032

Changes based on review

4f943f3

Divs-B force-pushed the db/implement-gh-scala-release-process branch from b90ab8f to 4f943f3 Compare January 17, 2024 16:40

removed boilerplate code

71adeea

Divs-B marked this pull request as ready for review January 17, 2024 16:52

Divs-B requested a review from a team as a code owner January 17, 2024 16:52

rtyley reviewed Jan 17, 2024

View reviewed changes

rtyley approved these changes Jan 17, 2024

View reviewed changes

Divs-B merged commit f8ce129 into main Jan 17, 2024
2 checks passed

Divs-B mentioned this pull request Jan 17, 2024

Fix artifact group id settings #404

Merged

rtyley added a commit that referenced this pull request Jun 11, 2024

Update release docs for gha-scala-library-release-workflow

738c686

This follows on from #402.

rtyley mentioned this pull request Jun 11, 2024

Update release docs for gha-scala-library-release-workflow #422

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement gha-scala-library-release-workflow release process. #402

Implement gha-scala-library-release-workflow release process. #402

Divs-B commented Jan 12, 2024

rtyley left a comment

Divs-B commented Jan 12, 2024

rtyley Jan 12, 2024

rtyley Jan 12, 2024

rtyley Jan 12, 2024 •

edited

Loading

Divs-B Jan 15, 2024

rtyley Jan 12, 2024

rtyley Jan 12, 2024

rtyley Jan 12, 2024 •

edited

Loading

rtyley Jan 17, 2024

rtyley left a comment

Divs-B commented Jan 17, 2024

	val scalaVersions = Seq("2.12.17", "2.13.12")
	val scalaVersions = Seq("2.12.18", "2.13.12")

		@@ -1 +1 @@
		ThisBuild / version := "19.4.2-SNAPSHOT"
		ThisBuild / version := "20.0.1-SNAPSHOT"

Implement gha-scala-library-release-workflow release process. #402

Implement gha-scala-library-release-workflow release process. #402

Conversation

Divs-B commented Jan 12, 2024

What does this change?

How to test

rtyley left a comment

Choose a reason for hiding this comment

Divs-B commented Jan 12, 2024

rtyley Jan 12, 2024

Choose a reason for hiding this comment

rtyley Jan 12, 2024

Choose a reason for hiding this comment

rtyley Jan 12, 2024 • edited Loading

Choose a reason for hiding this comment

Divs-B Jan 15, 2024

Choose a reason for hiding this comment

rtyley Jan 12, 2024

Choose a reason for hiding this comment

rtyley Jan 12, 2024

Choose a reason for hiding this comment

rtyley Jan 12, 2024 • edited Loading

Choose a reason for hiding this comment

rtyley Jan 17, 2024

Choose a reason for hiding this comment

rtyley left a comment

Choose a reason for hiding this comment

Divs-B commented Jan 17, 2024

rtyley Jan 12, 2024 •

edited

Loading

rtyley Jan 12, 2024 •

edited

Loading