Skip to content

Commit

Permalink
doc: replace overview with a diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
Saviq committed Jun 21, 2024
1 parent 2a88849 commit beb7f54
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 13 deletions.
17 changes: 4 additions & 13 deletions doc/sphinx/reference/continuous-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,10 @@ pipeline.

## Overview

There are a number of components to this story:
- Mir builds
- unit, integration, acceptance and performance tests
- including our [WayLand Conformance Suite - WLCS](https://github.com/canonical/wlcs)
- sanitizer runs
- ABI checks
- coverage measurement
- `.deb` package builds
- downstream Snap builds
- end-to-end testing across different hardware
- test procedures maintained within [mir-ci](https://github.com/canonical/mir-ci)
and [checkbox-mir](https://github.com/canonical/checkbox-mir)
- automations defined in a private repository, as it includes infrastructure credentials
There are a number of components to this story, and a diagram might make for a good overview:

```{mermaid} continuous-integration.mmd
```

These are run at different stages in the pipeline, balancing the time it takes to run and the
breadth of testing. We'll discuss those in more detail below.
Expand Down
16 changes: 16 additions & 0 deletions doc/sphinx/reference/continuous-integration.mmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
flowchart TD
PR{{Pull Request}} --> Builds(<a href="#mir-builds"><u>Builds and tests</u></a>
<a href="#unit-tests"><u>unit</u></a>
<a href="#acceptance-tests"><u>acceptance</u></a>
<a href="#integration-tests"><u>integration</u></a>
<a href="#performance-tests"><u>performance</u></a>)
PR --> Snaps(<a href="#downstream-snap-builds"><u>Downstream snaps</u></a>)
PR --> ABI(<a href="#abi-checks"><u>ABI checks</u></a>)
PR --> Coverage(<a href="#coverage-measurement"><u>Coverage</u></a>)
Push{{Push}} --> Builds
Push --> Coverage
Push --> Sanitizers(<a href="#sanitizer-runs"><u>Sanitizers</u></a>)
Push --> PPA(<a href="#deb-package-builds"><u><tt>.deb</tt> packages</u></a>)
PPA --> Snaps
Snaps --> EndToEnd(<a href="#end-to-end-testing"><u>End-to-end testing</u></a>)

0 comments on commit beb7f54

Please sign in to comment.