Skip to content

Commit 7125ec4

Browse files
[DOCUMENTATION] Apply CHanges as discussed in review (- WIP PR #420 -)
Changes in file docs/CI.md: * minor changes for grammer and consistancy * related work
1 parent 8f766cf commit 7125ec4

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/CI.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -139,13 +139,13 @@ pipeline.
139139

140140
### Acceptance Testing with CircleCI
141141

142-
While the comprehensive results from the extensive GHA pipeline offers a detailed look at the
142+
While the comprehensive results from the extensive GHA pipeline offer a detailed look at the
143143
state of the codebase, the process can take upwards of 30 minutes to complete. The Multicast
144144
Project also utilizes the much faster CircleCI offering to provide pass or fail status much earlier
145145
in CI/CD. While the underlying tests are the same for both GHA and CircleCI, they are only tested
146146
in a single environment on CircleCI, and typically perform faster.
147147

148-
#### How CircleCI on-`push` triggers propagate
148+
#### How `push` triggers propagate on CircleCI
149149

150150
```mermaid
151151
graph TD;
@@ -173,18 +173,18 @@ sole configuration file for the CircleCI jobs:
173173
are ephemeral and not attested)
174174
B. test: Tests that the Minimal Acceptance tests pass without failure, (albeit the test details
175175
are discarded, only the logs remain for a while on CircleCI)
176-
C. lint: Selectively lints (See Linting for details) the multicast python source (eg.
176+
C. lint: Selectively lints (See Linting for details) the multicast python source (eg.,
177177
`multicast/*.py`), failing on any linter flagged issues or passing on none.
178178
D. pytest: Runs the now deprecated `make test-pytest` target to discover, and then run,
179179
unittests via the `pytest` testing framework.
180180
i. **Test-Results**: the produced test results. See
181181
[Collect Tests with CircleCI](https://circleci.com/docs/collect-test-data/#pytest) for more.
182182
3. **GH-Checks**: Each CI/CD job will report back a GitHub Check run result.
183183

184-
In summary, as the diagram illustrates, a CircleCI pipeline CI/CD workflow begins with a push event,
185-
leading to the build, test, lint, and pytest jobs reporting back to GitHub Checks, indicating the
186-
status of each job. Additionally, the output from pytest generates some Test Results, which are
187-
then used to produce CircleCI Metrics.
184+
In summary, as the diagram illustrates, a CircleCI pipeline CI/CD workflow begins with a push
185+
event, leading to the build, test, lint, and pytest jobs reporting back to GitHub Checks,
186+
indicating the status of each job. Additionally, the output from pytest generates some Test
187+
Results, which are then used to produce CircleCI Metrics.
188188

189189
### How Integrations are triggered from Testing in CI/CD
190190

0 commit comments

Comments
 (0)