NOTE: This README contains information for the
.github
directory but cannot be located there because it will overwrite the repo README.
This directory contains workflows and scripts to support our CI infrastructure that runs on GitHub Actions.
- Pull CI (
pull.yml
) is run on PRs and on main. - Trunk CI (
trunk.yml
) is run on trunk to validate incoming commits. Trunk jobs are usually more expensive to run so we do not run them on PRs unless specified. - Scheduled CI (
periodic.yml
) is a subset of trunk CI that is run every few hours on main. - Binary CI is run to package binaries for distribution for all platforms.
Templates written in Jinja are located in the .github/templates
directory
and used to generate workflow files for binary jobs found in the .github/workflows/
directory. These are also a
couple of utility templates used to discern common utilities that can be used amongst different templates.
You will need jinja2
in order to regenerate the workflow files which can be installed using:
pip install -r .github/requirements/regenerate-requirements.txt
Workflows can be generated / regenerated using the following command:
.github/regenerate.sh
New generated binary workflows can be added in the .github/scripts/generate_ci_workflows.py
script. You can reference
examples from that script in order to add the workflow to the stream that is relevant to what you particularly
care about.
Different parameters can be used to achieve different goals, i.e. running jobs on a cron, running only on trunk, etc.
The label ciflow/trunk
can be used to run trunk
only workflows. This is especially useful if trying to re-land a PR that was
reverted for failing a non-default
workflow.
Currently most of our self hosted runners are hosted on AWS, for a comprehensive list of available runner types you
can reference .github/scale-config.yml
.
Exceptions to AWS for self hosted:
- ROCM runners
New runner types can be added by committing changes to .github/scale-config.yml
. Example: pytorch#70474
NOTE: New runner types can only be used once the changes to
.github/scale-config.yml
have made their way into the default branch
Testing pytorch/builder changes
In order to test changes to the builder scripts:
- Specify your builder PR's branch and repo as
builder_repo
andbuilder_branch
in.github/templates/common.yml.j2
. - Regenerate workflow files with
.github/regenerate.sh
(see above). - Submit fake PR to PyTorch. If changing binaries build, add an appropriate label like
ciflow/binaries
to trigger the builds.