pytorch/.github/scripts
Ning Xu 88e554b513 Move label check failure to mergebot (#94707)
Fixes https://github.com/pytorch/pytorch/issues/88098

This is a mirror of the same PR (https://github.com/Goldspear/pytorch/pull/3) that has been reviewed in my fork (due to it's a stacked PR).

==============
## Context
This the 3rd of the 3 PRs to address the issue 88098.

## What Changed
1. check_labels.py no longer fails, but only leaving a comment
2. trymerge.py now would fail if no required labels provided

## Tests
* dummy-repo trymerge run [fails without required label](https://github.com/Goldspear/pytorch-dummy/actions/runs/4162819216) and resulted in [a label error comment](https://github.com/Goldspear/pytorch-dummy/pull/3#issuecomment-1427756769)
* the above pr was [correctly merged](https://github.com/Goldspear/pytorch-dummy/pull/3) after label is added.

## Note to Reviewers
1st PR: https://github.com/pytorch/pytorch/pull/94179
2nd PR: https://github.com/pytorch/pytorch/pull/94899
3rd PR: this one
Pull Request resolved: https://github.com/pytorch/pytorch/pull/94707
Approved by: https://github.com/ZainRizvi
2023-03-03 15:09:14 +00:00
..
build_triton_wheel.py Extend torch-trition conda to 3.11 (#93117) 2023-02-06 22:14:57 +00:00
check_labels.py Move label check failure to mergebot (#94707) 2023-03-03 15:09:14 +00:00
collect_ciflow_labels.py [CI] Add known ciflow labels to probot (#94368) 2023-02-08 17:37:27 +00:00
comment_on_pr.py Retry Merge: extract utils from check labels ptr (#94899) 2023-03-01 20:40:30 +00:00
convert_lintrunner_annotations_to_github.py
ensure_actions_will_cancel.py
export_pytorch_labels.py Fix update_pytorch_labels workflow (#95227) 2023-02-21 18:26:21 +00:00
fetch_latest_green_commit.py Update rockset version (#94005) 2023-02-03 21:38:35 +00:00
filter_test_configs.py Apply filter logic to disabled jobs dynamically (#95442) 2023-03-01 00:10:35 +00:00
generate_binary_build_matrix.py Add new checks in CI system to verify the built linux pip wheel with cpu-cxx11-abi (#79409) 2023-02-14 12:59:03 +00:00
generate_ci_workflows.py [BE] Import Literal, Protocol, and Final from standard library typing as of Python 3.8+ (#94490) 2023-02-09 19:17:49 +00:00
generate_pytorch_version.py
get_workflow_job_id.py [BE][ez] Move hardcoded constants to function args (#93874) 2023-02-02 00:47:18 +00:00
github_utils.py Retry Merge: extract utils from check labels ptr (#94899) 2023-03-01 20:40:30 +00:00
gitutils.py [GHF] Fix ghstack branches in sync logic (#93298) 2023-01-30 21:00:51 +00:00
gql_mocks.json [GHF] Add submodule updates check (#95885) 2023-03-02 18:05:26 +00:00
kill_active_ssh_sessions.ps1
label_utils.py Move label check failure to mergebot (#94707) 2023-03-03 15:09:14 +00:00
lint_native_functions.py
parse_ref.py
pr-sanity-check.sh
README.md Refactor to extract label_utils from export_pytorch_labels (#94179) 2023-02-09 19:17:05 +00:00
report_git_status.sh
rockset_mocks.json trymerge to ignore certain failures (#91134) 2023-02-07 17:19:57 +00:00
run_torchbench.py
test_check_labels.py Move label check failure to mergebot (#94707) 2023-03-03 15:09:14 +00:00
test_fetch_latest_green_commit.py
test_filter_test_configs.py Apply filter logic to disabled jobs dynamically (#95442) 2023-03-01 00:10:35 +00:00
test_gitutils.py [GHF] Fix ghstack branches in sync logic (#93298) 2023-01-30 21:00:51 +00:00
test_label_utils.py Retry Merge: extract utils from check labels ptr (#94899) 2023-03-01 20:40:30 +00:00
test_trymerge.py Move label check failure to mergebot (#94707) 2023-03-03 15:09:14 +00:00
test_tryrebase.py Fix for tryrebase after PR was merged (#91337) 2022-12-28 18:44:08 +00:00
trymerge.py Move label check failure to mergebot (#94707) 2023-03-03 15:09:14 +00:00
trymerge_explainer.py [mergebot] Flatten workflows into jobs, fix bugs (#92097) 2023-01-18 23:38:16 +00:00
tryrebase.py Retry Merge: extract utils from check labels ptr (#94899) 2023-03-01 20:40:30 +00:00
update_commit_hashes.py
wait_for_ssh_to_drain.ps1

pytorch/.github

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.

Workflows

  • Pull CI (pull.yml) is run on PRs and on master.
  • 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 master.
  • Binary CI is run to package binaries for distribution for all platforms.

Templates

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.

(Re)Generating workflow files

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

Adding a new generated binary workflow

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.

ciflow (trunk)

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.

Infra

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

Adding new runner types

New runner types can be added by committing changes to .github/scale-config.yml. Example: https://github.com/pytorch/pytorch/pull/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:

  1. Specify your builder PR's branch and repo as builder_repo and builder_branch in .github/templates/common.yml.j2.
  2. Regenerate workflow files with .github/regenerate.sh (see above).
  3. Submit fake PR to PyTorch. If changing binaries build, add an appropriate label like ciflow/binaries to trigger the builds.