Skip to content

Commit

Permalink
Update index.md (CI/CD) split out tools into individual docs (#30315)
Browse files Browse the repository at this point in the history
* 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
kliao-csa authored and pull[bot] committed Jan 20, 2024
1 parent 41558e7 commit 2410065
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 31 deletions.
38 changes: 7 additions & 31 deletions docs/ci-cd/index.md
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
34 changes: 34 additions & 0 deletions docs/ci-cd/tools/daily_fail_summary.md
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

0 comments on commit 2410065

Please sign in to comment.