Add linux_pre_run_command to soundness #66
Conversation
Add a `linux_pre_run_command` input parameter to the soundness workflow jobs to allow callers to set up any dependencies or perform any other preparations before the soundness checks are executed. This is useful for example for repositories which require dependencies to be installed before the build.
.github/workflows/soundness.yml
Outdated
| @@ -63,6 +63,10 @@ on: | |||
| type: boolean | |||
| description: "Boolean to enable the Python lint check job. Defaults to true." | |||
| default: true | |||
| linux_pre_run_command: | |||
There was a problem hiding this comment.
Should this really be executed before every soundness check. It seems like this is only relevant for the ones that need to build something e.g. docs and api break
There was a problem hiding this comment.
I wondered that myself but I think it's plausible that a caller may want to do some other source preparations, munging, generation that this would permit.
There was a problem hiding this comment.
I'm not set on it being this way though if you'd rather we solve the immediate requirement.
There was a problem hiding this comment.
swift-java needs a bunch of weird stuff, like installing a JDK for builds to work.
I agree that it is only for things which "build" the formatting check for example does no need it. At least so far AFAICS, let's start with that and we can extend if necessary?
There was a problem hiding this comment.
Maybe have a more specific name, like linux_pre_build_command, and only run it in actions that build? And in the future, there can be another linux_pre_foo_command that doesn't interfere with the build one, and could be added to all of them (e.g. to print the environment or something).
There was a problem hiding this comment.
On a side note. I am wondering if the longer term strategy is to allow overriding the docker image.
There was a problem hiding this comment.
Yep, I'm happy taking this approach. Thanks for the feedback everyone.
Add a
linux_pre_run_commandinput parameter to the soundness workflow jobs to allow callers to set up any dependencies or perform any other preparations before the soundness checks are executed.This is useful for example for repositories which require dependencies to be installed before the build.
The
if:statement evaluates to false if the input is not defined or is set to""so the step does not appear in output.