Adopt gha-scala-library-release process #32

Divs-B · 2024-03-12T16:26:46Z

What does this change?

gha-scala-library-release-workflow provides these benefits:

better security for release credentials by isolating release phases into separate GitHub Workflow Jobs
removes a lot of sbt configuration (gha-scala-library-release-workflow automatically provides sensible defaults)
automated version compatibility checking, detecting binary & source incompatibilities, and setting SemVer-compliant version numbers appropriately - meaning that developers no longer have to assign version numbers, and sbt can now reliably detect when dependency eviction could cause runtime errors (see eg Runtime compatibility errors (eg NoSuchMethodError) facia-scala-client#301 !) - and so block those problems at build time.

Changes made according to Configuration section https://github.com/guardian/gha-scala-library-release-workflow/blob/main/docs/configuration.md

How to test

This PR in progress, need to verify sbt file with @rtyley and verify tests.
If all fine then we can try make preview release and test in some of clients using content-entity-model

How can we measure success?

should be able to make release for this library very easily,

rtyley

Thanks for adding CI in 92edec6 - note that you also can delete .travis.yml, as that's the legacy of an obsolete CI system!

rtyley · 2024-03-15T18:20:08Z

build.sbt

-  .settings(commonSettings)
-  .settings(npmBetaReleaseTagMaybe)
+  .settings(artifactProductionSettings)
+  .settings(npmBetaReleaseTagMaybe)//do we need to remove this?


Yep, we need to remove npmBetaReleaseTagMaybe, along with betaReleaseType & betaReleaseSuffix, etc!

rtyley · 2024-03-15T18:23:07Z

.github/workflows/release.yml

+          registry-url: https://registry.npmjs.org
+      - name: Release Typescript to NPM
+        run: |
+          sbt "project typescript" "releaseNpm ${{ needs.scala-maven-release.outputs.RELEASE_VERSION }}"


I think the typescript project is called typescriptClasses in this project, for some reason!

content-entity/build.sbt

Line 164 in aa49c1f

lazy val typescriptClasses = (project in file("ts"))

rtyley · 2024-03-15T18:27:44Z

build.sbt

+    packageDoc / publishArtifact := false, //do we need to remove this? also because if root is using "publish / skip := true" instead?
+    packageSrc / publishArtifact := false, //do we need to remove this? also because if root is using "publish / skip := true" instead?


Interesting - it looks like we've never published the thrift project as an artifact, so actually it would be right to put publish / skip := true on this submodule too!

rtyley · 2024-03-19T12:31:36Z

build.sbt

  // scrooge 21.3.0: Builds are now only supported for Scala 2.12+
  // https://twitter.github.io/scrooge/changelog.html#id11
-  crossScalaVersions := Seq("2.12.11", scalaVersion.value),
+  crossScalaVersions := Seq("2.12.18", scalaVersion.value),
  releaseCrossBuild := true,


This line needs to be moved down into the root project!

Suggested change

releaseCrossBuild := true,

releaseCrossBuild lives with releaseVersion and releaseProcess on the root-level aggregating project, not on the artifact-producing modules!

good spot, I will correct it now 👍

rtyley

I think this all looks good to me, apart from the fact that your tidying-up has now revealed that releaseCrossBuild := true was in the wrong place - once you've moved that I think this should be good to go!

Divs-B · 2024-03-19T15:58:52Z

Thanks @rtyley for your help in implementing the release process across all coPip's libraries (this being the last one).
we experiencing efficient results in releasing them.

Will merge this PR to proceed for release testing 👍

rtyley · 2024-03-19T16:37:16Z

Wonderful stuff! Don't forget to kick off a release!

https://github.com/guardian/content-entity/actions/workflows/release.yml

In this PR #32, we specified node-version-file in release.yml file to use .nvmrc file but we didn't add the file and hence got failed on NPM release. ref: https://github.com/guardian/content-entity/actions/runs/8360348474

Updating docs after #32 !

rtyley · 2024-03-20T18:06:23Z

build.sbt

-    packageDoc / publishArtifact := false,
-    packageSrc / publishArtifact := false,
+    publish / skip := true,


Ah whoops, I see what happened here! Yep, we didn't want to add publish / skip := true here, because we do want an artifact. I think we probably want the original configuration (packageDoc / publishArtifact := false & packageSrc / publishArtifact := false) to stay as it is - they are only blocking the publishing of src & doc, not attempting to stop all artifacts for this module altogetherm as publishArtifact := false would have been.

Thank you @rtyley for confirming, yeah I didn't realise I restricted its publish.
I will revert to old changes on this section now 👍

We have encountered an issue of content-entity-thrift not being released after the work in PR #32 to maven due to error in making its publish to false which is corrected in the PR here #36 To test this we are trying manually version update to the one after which content-entity-thrift didn't get release.

Divs-B · 2024-04-23T11:43:31Z

This release is verified and tested.
Checked in content-atom:guardian/content-atom#169 which eventually checked in content-api-models:guardian/content-api-models#246 which at the end tested in one of client using all that is apple-news:https://github.com/guardian/apple-news/pull/331

Adopt gha-scala-release process

9852e11

Divs-B requested a review from rtyley March 12, 2024 16:27

Add ci.yml, add test entry in build sbt

92edec6

rtyley reviewed Mar 15, 2024

View reviewed changes

Divs-B added 2 commits March 18, 2024 12:02

delete travis.yml

d13a195

changes based on review

d93bb82

Divs-B requested a review from rtyley March 18, 2024 12:22

Divs-B marked this pull request as ready for review March 18, 2024 12:25

Divs-B requested review from a team as code owners March 18, 2024 12:25

rtyley mentioned this pull request Mar 19, 2024

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

Open

rtyley reviewed Mar 19, 2024

View reviewed changes

rtyley approved these changes Mar 19, 2024

View reviewed changes

releaseCrossVersion to go in root project settings

70de1c2

Divs-B merged commit 864f9ee into main Mar 19, 2024
1 check passed

Divs-B mentioned this pull request Mar 20, 2024

Add .nvmrc file as specified for setup-node action #34

Merged

rtyley mentioned this pull request Mar 20, 2024

Update README.md for gha-scala-library-release-workflow #35

Merged

rtyley added a commit that referenced this pull request Mar 20, 2024

Update README.md for gha-scala-library-release-workflow

bfeb2f9

Updating docs after #32 !

rtyley reviewed Mar 20, 2024

View reviewed changes

Divs-B mentioned this pull request Mar 21, 2024

Remove publish false to fix thrift package release #36

Merged

This was referenced Mar 21, 2024

Test thrift release with version 3.0.0 #37

Closed

Temporary disable compatibility check on releases #38

Merged

rtyley mentioned this pull request Apr 16, 2024

Update build and include sbt publish GHA workflow guardian/anghammarad#193

Merged

rtyley mentioned this pull request Jun 25, 2024

Adopt GHA Scala Library Release Workflow & use Sonatype token rather than password guardian/apps-rendering-api-models#90

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adopt gha-scala-library-release process #32

Adopt gha-scala-library-release process #32

Divs-B commented Mar 12, 2024 •

edited

Loading

rtyley left a comment •

edited

Loading

rtyley Mar 15, 2024

rtyley Mar 15, 2024

rtyley Mar 15, 2024

rtyley Mar 19, 2024

Divs-B Mar 19, 2024

rtyley left a comment

Divs-B commented Mar 19, 2024

rtyley commented Mar 19, 2024

rtyley Mar 20, 2024

Divs-B Mar 21, 2024

Divs-B commented Apr 23, 2024

		packageDoc / publishArtifact := false, //do we need to remove this? also because if root is using "publish / skip := true" instead?
		packageSrc / publishArtifact := false, //do we need to remove this? also because if root is using "publish / skip := true" instead?

Adopt gha-scala-library-release process #32

Adopt gha-scala-library-release process #32

Conversation

Divs-B commented Mar 12, 2024 • edited Loading

What does this change?

How to test

How can we measure success?

rtyley left a comment • edited Loading

Choose a reason for hiding this comment

rtyley Mar 15, 2024

Choose a reason for hiding this comment

rtyley Mar 15, 2024

Choose a reason for hiding this comment

rtyley Mar 15, 2024

Choose a reason for hiding this comment

rtyley Mar 19, 2024

Choose a reason for hiding this comment

Divs-B Mar 19, 2024

Choose a reason for hiding this comment

rtyley left a comment

Choose a reason for hiding this comment

Divs-B commented Mar 19, 2024

rtyley commented Mar 19, 2024

rtyley Mar 20, 2024

Choose a reason for hiding this comment

Divs-B Mar 21, 2024

Choose a reason for hiding this comment

Divs-B commented Apr 23, 2024

Divs-B commented Mar 12, 2024 •

edited

Loading

rtyley left a comment •

edited

Loading