Overhaul GitHub Actions workflows #747
Draft
Conversation
This file contains hidden or 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
Building Python wheels is done in more than one workflow. This reusable workflow is based on the previous `bazeltest.yml`, with some improvements: - Addition of more platform combinations - Use of Pip caching in setup-python - Use of a parameter to control whether wheels are uploaded A number of the environment variables for cibuildwheel previously found in `bazeltest.yml` are now in the top-level `pyproject.toml`.
This workflow is used by other workflows to determine the types of files that were changed in a PR.
The functionality of this workflow is subsumed by the new `reusable_build_wheels.yaml` workflow.
This and the other new workflow `ci_build_library.yaml` subsume what was previously in the workflow `testing_wheels.yml`. The latter used to do both library build+test and wheel build+test; splitting out those activities into separate, smaller workflows makes things more modular and understandable.
This and the other new workflow `ci_build_wheel.yaml` subsume what was previously in the workflow `testing_wheels.yml`. Despite its name, the latter workflow used to do _both_ library build+test and wheel build+test; splitting out those activities into separate, smaller workflows makes things more modular and understandable.
This renames `python_format.yml` to `ci_format_checks.yaml`, to make the purpose more clear from the file name and to allow for the possibility that C++ format checks will be added later. In addition, this makes the workflow check whether the changes in a PR affected Python files. If not, execution is skipped, for greater efficiency. This also adds a `workflow_dispatch` event trigger so that this can be invoked manually (e.g., for testing).
This renames `dockertest.yml` to `ci_docker_tests.yaml`, to make the purpose more clear from the file name. In addition, it adds a step to check whether the changes in a PR are such that trying to build Docker images is warranted. (Specifically, if the only changes involve documentation files, then there's no point in running the Docker tests.)
Changes: - adds some best-practices elements (timeouts, permissions, etc.) - makes the git checkout only use the latest files instead of grabbing the entire repo history - use pip caching with setup-python - changes the execution time to be at night in PST
This splits `testing_wheels.yml` into separate workflows for greater modularity. The individual workflows now test whether the changes in a PR involved code files, and skip execution if only documentation was changed. In addition, the workflows have `workflow_dispatch` triggers to allow manual invocation for testing.
Now that there's a separate reusable workflow for building wheels, this workflow can invoke it instead of repeating the code. In addition, this commit adds best-practices things like job timeouts, commit hashes for action versions, and `workflow_dispatch` for manual invocation.
GitHub announced that `windows-2019` will be unsupported by June 30, 2025.
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 updates and overhauls all the workflows. Main changes:
setup-pythonpyproject.tomlfile