diff --git a/docs/ci-cd/index.md b/docs/ci-cd/index.md index de95d466bfa59c..616c34ece1d43e 100644 --- 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 b/scripts/tools/build_fail_definitions.yaml similarity index 100% rename from scripts/tools/build_fail_defs.yaml rename to scripts/tools/build_fail_definitions.yaml diff --git a/scripts/tools/summarize_fail.py b/scripts/tools/summarize_fail.py index 04b3b33077c4b6..556ddf823047d9 100644 --- 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: