Adopt GHA-Scala-Library-Release-Workflow #232

rtyley · 2024-01-19T16:55:20Z

This change adopts gha-scala-library-release-workflow for publishing releases of this library, replacing some of the work done in PR #229 and providing some improvements:

Automatic version-numbering based on automated compatibility-assessment by sbt-version-policy
Standardisation with the other projects across the Guardian that have also adopted the workflow
Reduced configuration (fewer sbt settings, and less workflow yaml) - we deleted a lot of lines! ✨

Changes to UX

Before: Developers would initiate a release by creating a Git tag with their choice of version number, and creating a GitHub Release with that tag. If the GitHub Release was 'pre-release', a beta-suffixed release would be made for Scala libraries only.
After: Developers run the release workflow, selecting whether they want to run it on the default main branch (a full release) or on a PR feature branch (a 'preview' release). Releases are always made for both Scala and Typescript libraries, but if this is a preview release, the NPM package will have an NPM tag of preview rather than latest.

Releasing Maven and NPM artifacts

This is a first for gha-scala-library-release-workflow - so far this workflow has only been used for publishing Scala projects to Maven - but the earlier work done in PR #229 supported automated release to both Maven and NPM (for NPM, we're talking Typescript artifacts generated from Thrift by scrooge-extras), and so it was important to continue to that support.

Rather than teach the gha-scala-library-release-workflow reusable-release.yml how to publish NPM artifacts, it was easier to just modify the standard release.yml workflow that calls reusable-release.yml, adding an additional NPM Release workflow job after the Maven release process:

This uses some of the code from PR #229, and we've verified that it continues to successfully publish a @guardian/content-api-models to NPM with a PREVIEW release.

Some projects output both Scala and NPM libraries with a single release - for example, we need to support this in content-api-models: guardian/content-api-models#232 ...rather than try to teach gha-scala-library-release-workflow how to do NPM releases, it seems better to let the workflow do the Scala release, and then output the release version number so that it can be used by a subsequent custom 'npm release' stage of caller workflow. See also: https://docs.github.com/en/actions/using-workflows/reusing-workflows#using-outputs-from-a-reusable-workflow

Needed for guardian/content-api-models#232

rtyley · 2024-01-23T17:30:20Z

build.sbt

+lazy val npmPreviewReleaseTagMaybe = if (sys.env.get("RELEASE_TYPE").contains("PREVIEW_FEATURE_BRANCH")) {
+  Seq(scroogeTypescriptPublishTag := "preview")
+} else Seq.empty


The NPM docs say "Other than latest, no tag has any special significance to npm itself."

...so we can tag things as preview, snapshot, or beta, as we like, and as the Scala workflow is producing PREVIEW releases, it makes sense, I think, to keep the NPM tag the same.

rtyley · 2024-01-23T17:34:08Z

build.sbt

-    case v if v == snapshotReleaseType =>
-      scroogeTypescriptPublishTag := "snapshot"
-  }.toSeq
+lazy val npmPreviewReleaseTagMaybe = if (sys.env.get("RELEASE_TYPE").contains("PREVIEW_FEATURE_BRANCH")) {


Note that the RELEASE_TYPE is coming from the environment variable supplied by release.yml:

content-api-models/.github/workflows/release.yml

Lines 32 to 35 in b48291c

sbt "project typescript" "releaseNpm ${{ needs.scala-maven-release.outputs.RELEASE_VERSION }}"

env:

NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

RELEASE_TYPE: ${{ needs.scala-maven-release.outputs.RELEASE_TYPE }}

The value of RELEASE_TYPE could be either PREVIEW_FEATURE_BRANCH or FULL_MAIN_BRANCH, as determined by gha-scala-library-release-workflow (see also guardian/gha-scala-library-release-workflow#19)

github-actions · 2024-01-23T18:01:55Z

@rtyley has published a preview version of this PR with release workflow run #42, based on commit 6d00eca:

18.1.0-PREVIEW.adopt-GHA-Scala-Library-Release-Workflow.2024-01-23T1754.6d00eca6

Note from Roberto:

This was a fun one - if you look at commit 6d00eca, you'll see that it is a pretty silly change, just used for double-checking that the NPM artifact released in a PREVIEW release was indeed based on the commit it claimed to be based on. I've now removed commit 6d00eca, as we definitely wouldn't want to merge that!

github-actions · 2024-01-24T16:30:45Z

@rtyley has published a preview version of this PR with release workflow run #45, based on commit e2d23aa:

18.0.1-PREVIEW.adopt-GHA-Scala-Library-Release-Workflow.2024-01-24T1623.e2d23aa4

Want to make another preview release?

Click 'Run workflow' in the GitHub UI, specifying the adopt-GHA-Scala-Library-Release-Workflow branch, or use the GitHub CLI command:

gh workflow run release.yml --ref adopt-GHA-Scala-Library-Release-Workflow

Want to make a full release after this PR is merged?

Click 'Run workflow' in the GitHub UI, leaving the branch as the default, or use the GitHub CLI command:

gh workflow run release.yml

This is just prior to the main work of #232

This change adopts `gha-scala-library-release-workflow` for publishing releases, replacing some of the work done in PR #229 and providing some improvements: * Automatic version-numbering based on automated compatibility-assessment by sbt-version-policy * Standardisation with the other projects across the Guardian that have also adopted the workflow * Reduced configuration (fewer sbt settings, and less workflow yaml) This specific commit only provides Scala Maven release, removing NPM release capability, but NPM release capability is returned in the next commit.

This is in addition to the Scala Maven release provided by the previous commit. This change is only separated out from the previous commit to show how the 'standard' release.yml has been modified for this dual Scala & Typescript release workflow. This is a first for gha-scala-library-release-workflow - so far that workflow has only been used for publishing Scala projects to Maven - but the earlier work done in PR #229 supported automated release to both Maven and NPM (for NPM, we're talking Typescript artifacts generated from Thrift by scrooge-extras), and so it was important to continue to that support. Rather than teach the gha-scala-library-release-workflow reusable-release.yml how to publish NPM artifacts, it was easier to just modify the standard release.yml workflow that calls reusable-release.yml, adding an additional NPM Release workflow job after the Maven release process.

emdash-ie · 2024-01-25T09:46:43Z

Looks good! Nice to have the workflow handling npm and maven together :)

Divs-B · 2024-01-25T09:58:46Z

Thankyou @rtyley for adding NPM release too in gha-scala-library-release-workflow, "Preview" release looks great! https://www.npmjs.com/package/@guardian/content-api-models?activeTab=versions

Details in PR description are great to understand. 👍

rtyley · 2024-01-25T11:25:25Z

Thanks both! After merging, I ran a standard full release on the default main branch, and it completed successfully with v18.0.1:

…s-scala Now that guardian/content-api-models#232 has been merged and https://github.com/guardian/content-api-models/releases/tag/v18.0.1 has been released, the content-api-models models now declare themselves to adhere to 'early-semver' - and even more than that, thanks to sbt-version-policy, they actually _do_ adhere to it! This should mean that it is **no longer possible** for a single project that depends on content-api-scala-client & content-api-models to have _incompatible_ versions of those artifacts - sbt will reject the incompatibility **at compile time**, where it can be fixed by just ensuring that all libraries (eg including facia-scala-client) have all been compiled against the same versions: https://www.scala-lang.org/blog/2021/02/16/preventing-version-conflicts-with-versionscheme.html This should prevent horrible runtime errors like guardian/facia-scala-client#301 which occurred with the rollout of the innocent-looking changes in https://github.com/guardian/facia-scala-client/releases/tag/v4.0.6 .

This was referenced Jan 19, 2024

Output release version to caller workflow guardian/gha-scala-library-release-workflow#25

Merged

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

Open

rtyley force-pushed the adopt-GHA-Scala-Library-Release-Workflow branch 3 times, most recently from ecab2f3 to e0dba48 Compare January 23, 2024 16:48

rtyley added a commit to guardian/gha-scala-library-release-workflow that referenced this pull request Jan 23, 2024

Add RELEASE_TYPE output from workflow

d3089a0

Needed for guardian/content-api-models#232

rtyley force-pushed the adopt-GHA-Scala-Library-Release-Workflow branch from e0dba48 to d7be5bd Compare January 23, 2024 17:27

rtyley commented Jan 23, 2024

View reviewed changes

guardian deleted a comment from github-actions bot Jan 24, 2024

rtyley force-pushed the adopt-GHA-Scala-Library-Release-Workflow branch 4 times, most recently from 97c5f49 to e2d23aa Compare January 24, 2024 16:22

rtyley force-pushed the adopt-GHA-Scala-Library-Release-Workflow branch 5 times, most recently from 46a290c to 20570f1 Compare January 24, 2024 17:54

Some version bumps

09fbc2f

This is just prior to the main work of #232

rtyley force-pushed the adopt-GHA-Scala-Library-Release-Workflow branch from 20570f1 to b48291c Compare January 24, 2024 18:08

rtyley added 2 commits January 24, 2024 18:15

rtyley force-pushed the adopt-GHA-Scala-Library-Release-Workflow branch from b48291c to d037761 Compare January 24, 2024 18:15

guardian deleted a comment from github-actions bot Jan 24, 2024

rtyley marked this pull request as ready for review January 24, 2024 18:18

rtyley requested a review from a team as a code owner January 24, 2024 18:18

emdash-ie approved these changes Jan 25, 2024

View reviewed changes

rtyley merged commit 553a91d into main Jan 25, 2024
1 check passed

rtyley deleted the adopt-GHA-Scala-Library-Release-Workflow branch January 25, 2024 11:25

rtyley mentioned this pull request Jan 25, 2024

Prevent runtime incompatibility with 'early-semver' content-api-models-scala guardian/content-api-scala-client#405

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-Workflow #232

Adopt GHA-Scala-Library-Release-Workflow #232

rtyley commented Jan 19, 2024 •

edited

Loading

rtyley Jan 23, 2024 •

edited

Loading

rtyley Jan 23, 2024 •

edited

Loading

github-actions bot commented Jan 23, 2024 •

edited by rtyley

Loading

github-actions bot commented Jan 24, 2024

emdash-ie commented Jan 25, 2024

Divs-B commented Jan 25, 2024

rtyley commented Jan 25, 2024

	sbt "project typescript" "releaseNpm ${{ needs.scala-maven-release.outputs.RELEASE_VERSION }}"
	env:
	NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
	RELEASE_TYPE: ${{ needs.scala-maven-release.outputs.RELEASE_TYPE }}

Adopt GHA-Scala-Library-Release-Workflow #232

Adopt GHA-Scala-Library-Release-Workflow #232

Conversation

rtyley commented Jan 19, 2024 • edited Loading

Changes to UX

Releasing Maven and NPM artifacts

rtyley Jan 23, 2024 • edited Loading

Choose a reason for hiding this comment

rtyley Jan 23, 2024 • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Jan 23, 2024 • edited by rtyley Loading

Note from Roberto:

github-actions bot commented Jan 24, 2024

emdash-ie commented Jan 25, 2024

Divs-B commented Jan 25, 2024

rtyley commented Jan 25, 2024

rtyley commented Jan 19, 2024 •

edited

Loading

rtyley Jan 23, 2024 •

edited

Loading

rtyley Jan 23, 2024 •

edited

Loading

github-actions bot commented Jan 23, 2024 •

edited by rtyley

Loading