From d2eda7f2f3d3121068aaa9fa8410d9b1fc34fe53 Mon Sep 17 00:00:00 2001
From: zhouzhuojie <zhouzhuojie@gmail.com>
Date: Wed, 11 Aug 2021 17:09:02 -0700
Subject: [PATCH] Add ciflow_ruleset.json generator along with gha ci (#63097)

Summary:
- Add `.github/generated-ciflow-ruleset.json` for ciflow-bot (so that we can generate better comments)
- The lint job also checks git dirty to make sure that the file is always in sync with ciflow configs

Pull Request resolved: https://github.com/pytorch/pytorch/pull/63097

Reviewed By: saketh-are

Differential Revision: D30263278

Pulled By: zhouzhuojie

fbshipit-source-id: bad68105a228e892ba071b29ecfdf433e1038054
---
 .gitattributes                           |  1 +
 .github/generated-ciflow-ruleset.json    | 20 ++++++++++++
 .github/scripts/generate_ci_workflows.py | 40 +++++++++++++++++++++++-
 3 files changed, 60 insertions(+), 1 deletion(-)
 create mode 100644 .github/generated-ciflow-ruleset.json

diff --git a/.gitattributes b/.gitattributes
index 20591f6f353..70246abe9bb 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -1,3 +1,4 @@
 *.bat text eol=crlf
 .circleci/config.yml linguist-generated=true
 .github/workflows/generated-*.yml linguist-generated=true
+.github/generated-* linguist-generated=true
diff --git a/.github/generated-ciflow-ruleset.json b/.github/generated-ciflow-ruleset.json
new file mode 100644
index 00000000000..32333bad3e1
--- /dev/null
+++ b/.github/generated-ciflow-ruleset.json
@@ -0,0 +1,20 @@
+{
+  "label_rules": {
+    "ciflow/default": [
+      "linux-bionic-py3.8-gcc9-coverage",
+      "linux-xenial-py3.6-gcc5.4",
+      "linux-xenial-py3.6-gcc7-bazel-test",
+      "win-vs2019-cpu-py3",
+      "win-vs2019-cuda10-cudnn7-py3"
+    ],
+    "ciflow/scheduled": [
+      "periodic-libtorch-linux-xenial-cuda11.3-cudnn8-py3.6-gcc7",
+      "periodic-linux-xenial-cuda11.3-cudnn8-py3.6-gcc7",
+      "periodic-win-vs2019-cuda11-cudnn8-py3"
+    ],
+    "ciflow/slow": [
+      "linux-xenial-cuda10.2-cudnn7-py3.6-gcc7"
+    ]
+  },
+  "version": "v1"
+}
diff --git a/.github/scripts/generate_ci_workflows.py b/.github/scripts/generate_ci_workflows.py
index 86acaa8e216..17f29111caf 100755
--- a/.github/scripts/generate_ci_workflows.py
+++ b/.github/scripts/generate_ci_workflows.py
@@ -2,9 +2,10 @@
 
 from dataclasses import asdict, dataclass, field
 from pathlib import Path
-from typing import Set
+from typing import Dict, Set
 
 import jinja2
+import json
 from typing_extensions import Literal
 
 YamlShellBool = Literal["''", 1]
@@ -82,6 +83,32 @@ class CIFlowConfig:
         self.gen_root_job_condition()
 
 
+@dataclass
+class CIFlowRuleset:
+    version = 'v1'
+    output_file = f'{GITHUB_DIR}/generated-ciflow-ruleset.json'
+    label_rules: Dict[str, Set[str]] = field(default_factory=dict)
+
+    def add_label_rule(self, labels: Set[str], workflow_name: str) -> None:
+        for label in labels:
+            if label in self.label_rules:
+                self.label_rules[label].add(workflow_name)
+            else:
+                self.label_rules[label] = {workflow_name}
+
+    def generate_json(self) -> None:
+        output = {
+            "version": self.version,
+            "label_rules": {
+                label: sorted(list(workflows))
+                for label, workflows in self.label_rules.items()
+            }
+        }
+        with open(self.output_file, 'w') as outfile:
+            json.dump(output, outfile, indent=2, sort_keys=True)
+            outfile.write('\n')
+
+
 @dataclass
 class CIWorkflow:
     # Required fields
@@ -418,6 +445,17 @@ if __name__ == "__main__":
         (jinja_env.get_template("windows_ci_workflow.yml.j2"), WINDOWS_WORKFLOWS),
         (jinja_env.get_template("bazel_ci_workflow.yml.j2"), BAZEL_WORKFLOWS),
     ]
+    ciflow_ruleset = CIFlowRuleset()
     for template, workflows in template_and_workflows:
         for workflow in workflows:
             workflow.generate_workflow_file(workflow_template=template)
+
+            if workflow.ciflow_config.enabled:
+                ciflow_ruleset.add_label_rule(workflow.ciflow_config.labels, workflow.build_environment)
+            elif workflow.on_pull_request:
+                # If ciflow is disabled but still on_pull_request, we can denote
+                # it as a special label 'ciflow/default' in the ruleset, which will be later
+                # turned into an actual 'ciflow/default' label in the workflow.
+                # During the rollout phase, it has the same effect as 'ciflow/default'
+                ciflow_ruleset.add_label_rule({'ciflow/default'}, workflow.build_environment)
+    ciflow_ruleset.generate_json()