ci: Add UI inputs for Update helm charts job, refactor and drop need for crds_asset_id
#400
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add UI inputs when workflow triggered as `workflow_dispatch`. Given that the values can come from `repository_dispatch` (other repos) or `workflow_dispatch` (UI button), add a new `setvariables` job, that sets its job outputs to the corresponding values obtained from the payload of the repository_dispatch or from the inputs of the workflow_dispatch. It is needed to use job outputs as is the only way to pass values between jobs, as jobs are run in their own VM instances and don't share the env. Make the following jobs depend on it with `needs: setvariables`. The javascript script from actions/github-script cannot read job outputs. Hence, add a step that reads the `needs.setvariables.outputs` and creates env vars. Consume those env vars in js as `process.env.foo`. Signed-off-by: Víctor Cuadrado Juan <[email protected]>
Instead of consuming the crds_asset_id from workflow inputs, query the repos to obtain the asset id, and use that id to download the CRDs.tar.gz. Signed-off-by: Víctor Cuadrado Juan <[email protected]>
Also, we don't need a js script to set them. Signed-off-by: Víctor Cuadrado Juan <[email protected]>
This simplifies testing, one can create
/tmp/crds-{controller,audit-scanner}.tar.gz and run the script locally.
Signed-off-by: Víctor Cuadrado Juan <[email protected]>
Signed-off-by: Víctor Cuadrado Juan <[email protected]>
viccuad
changed the title
Update helm charts job, refactor and drop need for crds_asset_id
This was referenced Mar 13, 2024
viccuad
commented
Mar 13, 2024
| core.exportVariable("UPDATECLI_CHART_VERSION", context.payload.client_payload.version) | ||
| - name: create env vars from needs.setvariables.outputs | ||
| # This is neeeded because in scripts, we don't have a way to access the `needs` json object. | ||
| # The env vars defined here will be accesible in the scripts under `process.env.foo` |
There was a problem hiding this comment.
It may be possible to drop this step, not save the vars as env vars, and in the script parse the needs.setvariables.outputs string into json.
So instead of let version = process.env.version do
let version = JSON.parse( ' ${{ needs.setvariables.outputs }} ' ).version.
But I couldn't get it to work.
Signed-off-by: Víctor Cuadrado Juan <[email protected]>
|
Updated input fields from review:
|
flavio
approved these changes
Mar 14, 2024
| core.exportVariable("UPDATECLI_CHART_VERSION", context.payload.client_payload.version) | ||
| - name: create env vars from needs.setvariables.outputs | ||
| # This is neeeded because in scripts, we don't have a way to access the `needs` json object. | ||
| # The env vars defined here will be accesible in the scripts under `process.env.foo` |
jvanz
approved these changes
Mar 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Fix #307
Changes:
workflow_dispatch.Given that the values can come from
repository_dispatch(other repos) orworkflow_dispatch(UI button), add a newsetvariablesjob, that sets its job outputs to the corresponding values obtained from the payload of the repository_dispatch or from the inputs of the workflow_dispatch.It is needed to use job outputs as is the only way to pass values between jobs, as jobs are run in their own VM instances and don't share the env.
Make the following jobs depend on it with
needs: setvariables.The javascript script from actions/github-script cannot read job outputs. Hence, add a step that reads the
needs.setvariables.outputsand creates env vars. Consume those env vars in js asprocess.env.foo.update_cli/scripts/install_crds.sh.Test
Major/minor release update run: https://github.com/viccuad/helm-charts/actions/runs/8263364335
Patch release update run: https://github.com/viccuad/helm-charts/actions/runs/8263508789/job/22605107087
Also, tested
updatecli/scripts/install_crds.shlocally, with various/tmp/crds-{controller,audit-scanner}.tar.gz.Additional Information
Tradeoff
Potential improvement
I don't like the added complexity created by adding the workflow_dispatch
inputs, and needing to pass it to the js scripts via GH env vars, but it is what it is.About the refactors, I'm happy splitting the commits in several PRs. I tested it altogether to save time. If they aren't wanted they can be dropped, or we can go with #399.