CI CD docs update (#30251)

* Update index.md * Restyled by prettier-markdown (#30252) Co-authored-by: Restyled.io <[email protected]> * Link fail defs yaml * Restyled by prettier-markdown (#30253) Co-authored-by: Restyled.io <[email protected]> * fix file name for spell check * Rename build_fail_defs.yaml to build_fail_definitions.yaml * Update summarize_fail.py --------- Co-authored-by: restyled-io[bot] <32688539+restyled-io[bot]@users.noreply.github.com> Co-authored-by: Restyled.io <[email protected]>
project-chip · Nov 29, 2023 · 7430677 · 7430677
1 parent 56c6417
commit 7430677
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 6 deletions.
diff --git a/docs/ci-cd/index.md b/docs/ci-cd/index.md
@@ -8,22 +8,36 @@
 
 ### Daily Fail Summary
 
+#### Source
+
 Workflow:
 https://github.com/project-chip/connectedhomeip/blob/master/.github/workflows/recent_fail_summary.yaml
 
 Script:
 https://github.com/project-chip/connectedhomeip/blob/master/scripts/tools/summarize_fail.py
 
+Fail Definitions:
+https://github.com/project-chip/connectedhomeip/blob/master/scripts/tools/build_fail_definitions.yaml
+
+#### Summary
+
 Runs once per day; takes inventory of the previous day's workflow runs and
 parses them for fail statistics. Creates temporarily cached artifacts for easy
 data parsing. Also saves a daily pass percentage list of all workflows at
-https://github.com/project-chip/connectedhomeip/blob/daily_pass_percentage/docs/daily_pass_percentage.md
+https://github.com/project-chip/connectedhomeip/blob/daily_pass_percentage/docs/daily_pass_percentage.md.
+Fail definitions can be added to the file defined above to allow fast root cause
+determination of any fail with an error message.
+
+#### Improvement Ideas
+
+-   Keep fail signature list updated to track causes of all common fails
+-   Make script artifact more known and accessible so it can be easily shared
+    and used by everyone
+-   Deliver daily fail summaries in short form through a Slack bot for easy
+    access
 
 ## To Do
 
 -   Cert image auto build
 
-## Improvement Ideas
-
--   Deliver daily fail summaries in short form through a Slack bot for easy
-    access
+## General Improvement Ideas
diff --git a/scripts/tools/build_fail_defs.yaml → scripts/tools/build_fail_definitions.yaml b/scripts/tools/build_fail_defs.yaml → scripts/tools/build_fail_definitions.yaml
diff --git a/scripts/tools/summarize_fail.py b/scripts/tools/summarize_fail.py
@@ -10,7 +10,7 @@
 
 yesterday = (datetime.datetime.now() - datetime.timedelta(days=1)).strftime('%Y-%m-%d')
 
-with open("scripts/tools/build_fail_defs.yaml", "r") as fail_defs:
+with open("scripts/tools/build_fail_definitions.yaml", "r") as fail_defs:
     try:
         error_catalog = yaml.safe_load(fail_defs)
     except Exception: