kata-deploy: improving the runtimeclasses checker and documentation #9822
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
wainersm
added
area/ci
wainersm
force-pushed
the
kata-deploy-runtimeclasses-checker
branch
from
0fa3ddd
to
1c7e11a
Compare
|
Tentatively making spell and commit checkers happy. |
beraldoleal
approved these changes
Jun 11, 2024
There was a problem hiding this comment.
Very welcome @wainersm thanks.
Just a nit pic suggestion for you.
| cat kata-runtimeClasses.yaml | ||
| echo "::endgroup::" | ||
| echo "" | ||
| diff resultingRuntimeClasses.yaml kata-runtimeClasses.yaml |
There was a problem hiding this comment.
Amen!! +100 for removing scripts from yaml files \o/
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| name: Static checks |
There was a problem hiding this comment.
iiuc, since this is the name of the workflow, my suggestion would be to move to line 1.
Created the tools/packaging/kata-deploy/local-build/check-runtimeclasses.sh script and adjusted the worfklow to call it. This way developers can run the checker locally more easily. Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
As is, check-runtimeclasses.sh behavior is unexpected because the `sort` command relies on LC_ALL. For example, in some environment it can sort "kata-qemu-se.yaml kata-qemu-sev.yaml" and in other "kata-qemu-sev.yaml "kata-qemu-se.yaml". Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
To allow running the checker many times on same environment and providing a more user-friendly results. Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
This workflow is meant to check changes in tools/packaging/kata-deploy/runtimeclasses so let's not run on every and each PR. While here, it was gave a name to the job so that on UI it will show up as 'Static checks / kata-deploy-runtime-classes-check' similarly to other static checks (e.g. 'Static checks / check-kernel-config-version'). Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
Created a `Development` section in kata-deploy's README and documented the process to add a new runtimeClass. Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
The spell-checker was complaining about `runtimeClass` word. Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
wainersm
force-pushed
the
kata-deploy-runtimeclasses-checker
branch
from
1c7e11a
to
188adca
Compare
|
Updated to address @beraldoleal 's suggestion; now the job's name is on first line. |
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.
While working on PR #9807 it was a little of a pain to pass the static checker for the runtimeClasses that kata-deploy deploys on the cluster. I realized that it wasn't the first time I had the same difficult to pass CI, likely because I wasn't able to run the checker locally. So here I am sending some improvements to allow devs to run the checker locally before submitting a PR. In particular, the
LC_ALL=Ctrick was hurting my tentative to get the checker passing.Taking that opportunity to also document how to add a new runtimeClass to kata-deploy.