Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CI] Change how we define the matrix #2942

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

[CI] Change how we define the matrix #2942

wants to merge 2 commits into from

Conversation

FranzBusch
Copy link
Member

Motivation

Modification

Result

@FranzBusch FranzBusch force-pushed the fb-gha-matrix branch 30 times, most recently from 908c3bc to 7dc951e Compare October 24, 2024 12:11
@FranzBusch FranzBusch force-pushed the fb-gha-matrix branch 6 times, most recently from 70b0136 to 1eb066d Compare October 24, 2024 12:24
@FranzBusch FranzBusch added the semver/none No version bump required. label Oct 24, 2024
# Motivation

# Modification

# Result
rnro added a commit that referenced this pull request Dec 5, 2024
Introduce and adopt a new method for defining test matrices,
`swift_test_matrix.yml`.

⚠️ Any external adopters of the unit tests, Cxx interop and benchmarks
workflows are automatically opted in to use the new infrastructure.

### Motivation:

* The current matrix workflow has the limitation that it only supports
pre-defined sets of variables which are explored in the test matrix. At
the moment this is a pre-defined set of Swift versions on Linux and
Windows.
* Adding more means hard-coding them at multiple levels of the workflow
hierarchy.
* Currently skipped Windows matrix jobs show up as successes in the
GitHub UI leading to a misleading impression of good coverage.

### Modifications:

Introduce and adopt a new method for defining test matrices,
`swift_test_matrix.yml`. The new method is based around the approach of
defining the test matrix via a JSON object which may be supplied via an
input string from another workflow or from a file on-disk in a
repository.

Taking this approach means that we have the ability to add new targets
to the matrix simply by adding new elements to the JSON array,
increasing flexibility and the scope for future growth.

The unit tests, Cxx interop and benchmarks workflows are all modified to
use the new approach, this opts-in all downstream adopters. This should
be transparent to all downstream adopters.

In order to unify the Linux and Windows jobs I removed the use of the
`container:` GitHub Actions affordance in the Linux jobs which
transparently means all steps are executed within the nested container.
Instead we must manually call in to the docker container which
complicates scripting a little. I tested to see if doing this slowed
down the jobs (perhaps GitHub was caching the docker images more
intelligently) but it does not.

This approach follows the pattern of @FranzBusch 's open PR
#2942

### Result:

* More flexible test matrix definitions
* No more false-passes for disabled Windows targets
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver/none No version bump required.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant