.github: refactor job matrix generation into YAML files #26019
Merged
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
This commit addresses two main issues and introduces a more streamlined approach to generating job matrices for GitHub Actions. By migrating the job matrix definition into YAML files, we gain the ability to separate scheduled jobs and pull requests (PRs) into specific files, ensuring comprehensive testing coverage similar to what we have with Jenkins. The first benefit of this approach is the improved organization of job definitions. With separate files for scheduled jobs and PRs, it becomes easier to manage and maintain testing configurations independently. This modular structure allows us to make changes to specific job types without impacting others, enhancing overall maintainability. The second advantage is with help of jq, we can define kernel versions for all desired Kubernetes (k8s) versions to be tested without manually commenting out unwanted versions. Previously, when using the "include" mechanism, certain k8s versions like 1.24 had to be commented out to prevent their execution. However, with jq, we can selectively include only the desired k8s versions by mapping them with the definitions in main-prs.yaml or main-scheduled.yaml. Lastly, this refactor enables per-branch configuration through prefixed filenames. By structuring configuration files with branch-specific prefixes, we can easily define and manage job configurations tailored to stable branches. Signed-off-by: André Martins <andre@cilium.io>
maintainer-s-little-helper
bot
added
the
dont-merge/needs-release-note-label
aanm
added
area/CI
maintainer-s-little-helper
bot
removed
the
dont-merge/needs-release-note-label
brlbil
approved these changes
Jun 8, 2023
nebril
reviewed
Jun 9, 2023
| ref: ${{ needs.check_changes.outputs.matrix_sha }} | ||
| persist-credentials: false | ||
|
|
||
| - name: Convert YAML to JSON |
There was a problem hiding this comment.
Is this done because we need jq-specific features that yq is lacking?
There was a problem hiding this comment.
@nebril no, it's because of the there isn't a fromYaml function, similar to the fromJson on GitHub as documented https://docs.github.com/en/enterprise-cloud@latest/actions/learn-github-actions/expressions#fromjson
nebril
approved these changes
Jun 9, 2023
There was a problem hiding this comment.
This is awesome! I think one thing missing would be adding some kind of yaml schema for new branch-*.yaml files, that would validate their structure. I think that debugging errors made in these files would be pretty painful, so it might make sense to make these as obvious as possible.
I don't think it's blocking though, it could be tracked in a new issue.
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.
This commit addresses two main issues and introduces a more streamlined approach to generating job matrices for GitHub Actions. By migrating the job matrix definition into YAML files, we gain the ability to separate scheduled jobs and pull requests (PRs) into specific files, ensuring comprehensive testing coverage similar to what we have with Jenkins.
The first benefit of this approach is the improved organization of job definitions. With separate files for scheduled jobs and PRs, it becomes easier to manage and maintain testing configurations independently. This modular structure allows us to make changes to specific job types without impacting others, enhancing overall maintainability.
The second advantage is with help of jq, we can define kernel versions for all desired Kubernetes (k8s) versions to be tested without manually commenting out unwanted versions. Previously, when using the "include" mechanism, certain k8s versions like 1.24 had to be commented out to prevent their execution. However, with jq, we can selectively include only the desired k8s versions by mapping them with the definitions in main-prs.yaml or main-scheduled.yaml.
Lastly, this refactor enables per-branch configuration through prefixed filenames. By structuring configuration files with branch-specific prefixes, we can easily define and manage job configurations tailored to stable branches.