From 32cb93b1a4c565a28494cd43fd3fc8226bea7f2c Mon Sep 17 00:00:00 2001 From: Kai Liao <140431279+kliao-csa@users.noreply.github.com> Date: Wed, 8 Nov 2023 11:23:26 -0700 Subject: [PATCH] Update index.md (CI/CD) split out tools into individual docs (#30315) * Update index.md (CI/CD) split out tools into individual docs * Create daily_fail_summary.md * Update index.md * Update daily_fail_summary.md * Update index.md * Update index.md * Update index.md --- docs/ci-cd/index.md | 38 +++++--------------------- docs/ci-cd/tools/daily_fail_summary.md | 34 +++++++++++++++++++++++ 2 files changed, 41 insertions(+), 31 deletions(-) create mode 100644 docs/ci-cd/tools/daily_fail_summary.md diff --git a/docs/ci-cd/index.md b/docs/ci-cd/index.md index 82b75bd864666b..24dcc86d061c50 100644 --- a/docs/ci-cd/index.md +++ b/docs/ci-cd/index.md @@ -1,45 +1,21 @@ # CI/CD Documentation +```{toctree} +:glob: + +tools/* +``` + ## Known Issues - Python build running out of space ## Tools -### 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. -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 +- [Daily Fail Summary](tools/daily_fail_summary.md) ## To Do - Cert image auto build -- Include Darwin Test fail definitions in fail summary script - for starters, - Test Reliable Message Protocol ## General Improvement Ideas diff --git a/docs/ci-cd/tools/daily_fail_summary.md b/docs/ci-cd/tools/daily_fail_summary.md new file mode 100644 index 00000000000000..8855a7a3de6086 --- /dev/null +++ b/docs/ci-cd/tools/daily_fail_summary.md @@ -0,0 +1,34 @@ +### 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. +Fail definitions can be added to the file defined above to allow fast root cause +determination of any fail with an error message. + +#### To Do + +- Keep fail signature list updated to track causes of all common fails +- Include Darwin Test fail definitions in fail summary script - for starters, + Test Reliable Message Protocol + +#### Improvement Ideas + +- 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