Introduce sbtStepPreamble
to GHA plugin
#64
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Based on #62. Fixes #61.
With all modesty 😁 I think this is a simple and very powerful idea.
Currently, when sbt-gh-actions generates a
WorkflowStep.Sbt
, it always prepends the user commands with++${{ matrix.scala }}
. So, the steps run with the Scala version set in the matrix. This is fantastic when your matrix is crossed on Scala versions.However, our matrices are now often crossed on other things as well that are controlled via sbt, such as JVM/JS, or in JS projects, the JS runtime used (Node.js, browsers, etc.).
This PR exposes these "preamble commands" as a new
githubWorkflowBuildSbtStepPreamble
that defaults to++${{ matrix.scala }}
. Some useful adjustments of this setting may be to:project ${{ matrix.project }}
command, to select arootJVM
orrootJS
projectset Global / useJSEnv := ${{ matrix.jsenv }}
, to change the runtime used for JS tests++${{ matrix.scala }}
altogether, for projects using sbt-projectmatrix to manage their buildsIn general, I think this introduces a lot of flexibility, that will make it easier to implement #60.