ci: run dependency sync script periodically and open a PR for it #339
Conversation
| git commit -am "go.mod: sync dependencies with k6 core" | ||
| git push -f -u origin "$BRANCH_NAME" | ||
|
|
||
| cat <<EOF > pr-body.txt |
There was a problem hiding this comment.
I'm not a fan of embedding texts in this way. I would prefer to have a script that generates this output.
There was a problem hiding this comment.
I'm not sure I follow. WDYM by a script that generates the output? Something like this same code but in a separate .sh file?
There was a problem hiding this comment.
What would be the advantage in this case? I agree the heredoc is not particularly pretty, but to me moving it to a separate script will make the yaml file harder to follow, as you would need to go somewhere else to check what the file is doing. Moreover such script wouldn't make sense outside of the context of this particular CI step.
There was a problem hiding this comment.
Basically, I think it is a bad practice to put any logic that does not depend on the CI environment (e.g. retrieving information provided by the CI) in the CI. Using a separate script allows running and testing this logic locally, if needed.
There was a problem hiding this comment.
Makes sense. I've added a depsync.sh script that does pretty much everything that is not related to git. LMK if this looks better :)
Description
This PR introduces a CI job that runs
hack/depsyncevery day, and creates (or updates if it exists) a PR with the changes it produces.PR should only be created if the job produces any changes to the git repository.
An example of the PR that would be created can be found here: roobre#28
Unfortunately, this does not currently trigger the regular PR workflow that would unittest those changes. This is a deliberate limitation of GH actions, as they automatically-generated
GITHUB_TOKENs they use do not trigger other workflows themselves.As a workaround for this, we can simply close and then reopen the PR, which will trigger the usual CI jobs for it, which the PR description says as a reminder. As I don't foresee having to do this very often, I think this workaround is enough and less maintenance than the alternative of creating a GitHub applciation.
Checklist:
make lint) and all checks pass.make test) and all tests pass.make integration-xxxforagentrelated changes)make e2e-xxxfordisruptors,kubernetesorclusterrelated changes)