3e4f213e82
Summary: Pull Request resolved: https://github.com/pytorch/pytorch/pull/20758 ghimport-source-id: ffb4c97c42c6efbb16ea5d93ea8af1bdf71cb1e4 Differential Revision: D15435639 Pulled By: ezyang fbshipit-source-id: a12bde8b0b11bbe0d0280b6b3994d9c65dc4f5cc
CircleCI configuration generator
One may no longer make changes to the .circleci/config.yml file directly.
Instead, one must edit these Python scripts or files in the verbatim-sources/ directory.
Usage
- Make changes to these scripts.
- Run the
regenerate.shscript in this directory and commit the script changes and the resulting change toconfig.yml.
You'll see a build failure on TravisCI if the scripts don't agree with the checked-in version.
Motivation
These scripts establish a single, authoritative source of documentation for the CircleCI configuration matrix. The documentation, in the form of diagrams, is automatically generated and cannot drift out of sync with the YAML content.
Furthermore, consistency is enforced within the YAML config itself, by using a single source of data to generate multiple parts of the file.
- Facilitates one-off culling/enabling of CI configs for testing PRs on special targets
Also see https://github.com/pytorch/pytorch/issues/17038
Future direction
Declaring sparse config subsets
See comment here:
In contrast with a full recursive tree traversal of configuration dimensions,
in the future future I think we actually want to decrease our matrix somewhat and have only a few mostly-orthogonal builds that taste as many different features as possible on PRs, plus a more complete suite on every PR and maybe an almost full suite nightly/weekly (we don't have this yet). Specifying PR jobs in the future might be easier to read with an explicit list when we come to this.