Skip to content

Commit 99f61c2

Browse files
kliao-csarestyled-io[bot]restyled-commits
authored
CI CD docs update (project-chip#30251)
* Update index.md * Restyled by prettier-markdown (project-chip#30252) Co-authored-by: Restyled.io <commits@restyled.io> * Link fail defs yaml * Restyled by prettier-markdown (project-chip#30253) Co-authored-by: Restyled.io <commits@restyled.io> * 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 <commits@restyled.io>
1 parent 9b64072 commit 99f61c2

File tree

3 files changed

+20
-6
lines changed

3 files changed

+20
-6
lines changed

docs/ci-cd/index.md

+19-5
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,36 @@
88

99
### Daily Fail Summary
1010

11+
#### Source
12+
1113
Workflow:
1214
https://github.com/project-chip/connectedhomeip/blob/master/.github/workflows/recent_fail_summary.yaml
1315

1416
Script:
1517
https://github.com/project-chip/connectedhomeip/blob/master/scripts/tools/summarize_fail.py
1618

19+
Fail Definitions:
20+
https://github.com/project-chip/connectedhomeip/blob/master/scripts/tools/build_fail_definitions.yaml
21+
22+
#### Summary
23+
1724
Runs once per day; takes inventory of the previous day's workflow runs and
1825
parses them for fail statistics. Creates temporarily cached artifacts for easy
1926
data parsing. Also saves a daily pass percentage list of all workflows at
20-
https://github.com/project-chip/connectedhomeip/blob/daily_pass_percentage/docs/daily_pass_percentage.md
27+
https://github.com/project-chip/connectedhomeip/blob/daily_pass_percentage/docs/daily_pass_percentage.md.
28+
Fail definitions can be added to the file defined above to allow fast root cause
29+
determination of any fail with an error message.
30+
31+
#### Improvement Ideas
32+
33+
- Keep fail signature list updated to track causes of all common fails
34+
- Make script artifact more known and accessible so it can be easily shared
35+
and used by everyone
36+
- Deliver daily fail summaries in short form through a Slack bot for easy
37+
access
2138

2239
## To Do
2340

2441
- Cert image auto build
2542

26-
## Improvement Ideas
27-
28-
- Deliver daily fail summaries in short form through a Slack bot for easy
29-
access
43+
## General Improvement Ideas
File renamed without changes.

scripts/tools/summarize_fail.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
yesterday = (datetime.datetime.now() - datetime.timedelta(days=1)).strftime('%Y-%m-%d')
1212

13-
with open("scripts/tools/build_fail_defs.yaml", "r") as fail_defs:
13+
with open("scripts/tools/build_fail_definitions.yaml", "r") as fail_defs:
1414
try:
1515
error_catalog = yaml.safe_load(fail_defs)
1616
except Exception:

0 commit comments

Comments
 (0)