Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adopt GHA Scala Library Release Workflow #23

Merged
merged 1 commit into from
Nov 23, 2024

Conversation

rtyley
Copy link
Member

@rtyley rtyley commented Nov 22, 2024

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.

The configuration changes for adopting gha-scala-library-release-workflow are documented in configuration.md .

[`gha-scala-library-release-workflow`](https://github.com/guardian/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 guardian/facia-scala-client#301 !) - and so block those problems at build time.

The configuration changes for adopting `gha-scala-library-release-workflow` are documented in [configuration.md](https://github.com/guardian/gha-scala-library-release-workflow/blob/main/docs/configuration.md) .
@rtyley rtyley force-pushed the adopt-GHA-Scala-Library-Release-Workflow branch from e9f423f to f44d66b Compare November 23, 2024 09:01
@rtyley rtyley merged commit ac83adb into main Nov 23, 2024
1 check passed
@rtyley rtyley deleted the adopt-GHA-Scala-Library-Release-Workflow branch November 23, 2024 11:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant