-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
- Loading branch information
Showing
2 changed files
with
41 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |