22
33Continuous Integration details for the Multicast project.
44
5- ## CI Service providers
5+ ## CI Service Providers
66
77***
88
@@ -57,7 +57,7 @@ automated analysis.
5757
5858> [ !CAUTION]
5959> The Appveyor integration is still experimental, as the multicast module is not currently able to
60- > support running on windows .
60+ > support running on Windows .
6161
6262| Triggers | Jobs |
6363| --------| --------|
@@ -115,7 +115,7 @@ A configuration file that processes the build artifacts to create:
1151154 . [ CI-Tests.yml] ( https://github.com/reactive-firewall/multicast/tree/HEAD/.github/workflows/Tests.yml ) :
116116A configuration file for executing tests, which processes the build artifacts to create:
117117 A. Coverage reports: Uploading various coverage reports for the tests executed to multiple
118- services for analysis (eg. codecov.io, codeclimate.com, app.deepsource.io, etc.).
118+ services for analysis (e.g., codecov.io, codeclimate.com, app.deepsource.io, etc.).
119119 B. Test-Results-Artifacts
120120 (` {{ test-group }} ` -Test-Report-` {{ matrix.os }} ` -` {{ matrix.python-version }} ` ):
121121 Contains the results of the tests grouped by ` coverage|doctests|integration ` , ` os ` and
@@ -190,7 +190,7 @@ then used to produce CircleCI Metrics.
190190
191191#### Key integrations
192192
193- There are many integrations with various service providers used in the Multicast Project 's CI/CD
193+ There are many integrations with various service providers used in the Multicast project 's CI/CD
194194pipeline.
195195
196196``` mermaid
@@ -330,8 +330,9 @@ including [Python](docs/Testing.md#Python), [YAML](docs/Testing.md#YAML),
330330[ Makefile] ( docs/Testing.md#Makefile ) , [ Bash] ( docs/Testing.md#Bash ) , and
331331[ Markdown] ( docs/Testing.md#Markdown ) .
332332
333- Some of Multicast Project styles and conventions are quite specific (eg. custom locking conventions
334- of [ CEP-5] ( https://gist.github.com/reactive-firewall/3d2bd3cf37f87974df6f7bee31a05a89 ) ), and not
333+ Some of Multicast project styles and conventions are quite specific (e.g., custom locking
334+ conventions of
335+ [ CEP-5] ( https://gist.github.com/reactive-firewall/3d2bd3cf37f87974df6f7bee31a05a89 ) ), and not
335336yet automated. However, by leveraging linters, we not only ensure a level of maintainability but
336337also foster a collaborative environment where developers can focus on writing effective code rather
337338than getting bogged down by stylistic concerns.
@@ -340,8 +341,8 @@ than getting bogged down by stylistic concerns.
340341
341342Most of the linting in CI/CD is performed by GitHub workflows with the exception of a minimal
342343` Flake-8 ` scan for python source-code performed via CircleCI by the aptly named ` Lint ` job. All of
343- the linter reporting (eg. anything more than pass/fail status) is from the GitHub linter workflows.
344- There are two noteworthy forms of feedback from the various linting automation,
344+ the linter reporting (e.g., anything more than pass/fail status) is from the GitHub linter
345+ workflows. There are two noteworthy forms of feedback from the various linting automation,
345346[ code-scanning reports] ( https://docs.github.com/en/code-security/code-scanning ) , and
346347[ GitHub Anotated Messages] ( https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-a-debug-message ) .
347348All linting workflows failures result in alerts that can be reviewed with the relevant
@@ -350,7 +351,7 @@ albeit with different levels of details per linter workflow and target branch.
350351
351352#### Linting phases
352353
353- The generalized design of linter workflows in the Multicast Project CI/CD pipeline follows these
354+ The generalized design of linter workflows in the Multicast project CI/CD pipeline follows these
354355same phases:
355356
356357* ** Initialization** - Bootstraps environment and any initial setup automatically
@@ -362,11 +363,11 @@ same phases:
362363> [ !IMPORTANT]
363364> This overview does not address the complexities of CI/CD timing, concurrency, or the various
364365> combinations of linter workflows that run simultaneously. Each linter workflow is separately
365- > triggered (eg. push versus PR, etc.) and thus _ logicly _ disjoint (See CI/CD Triggering for
366+ > triggered (e.g., push versus PR, etc.) and thus _ logically _ disjoint (See CI/CD Triggering for
366367> details). Each linter workflow varies in its exact implementation of the afore mentioned phases.
367368
368- Logically (eg. ignoring complexities of concurrency and trigger conditionals, etc.) the order
369- of phases are sequential per single CI/CD linter workflow.
369+ Logically (e.g., ignoring complexities of concurrency and trigger conditionals, etc.) the order
370+ of phases is sequential per single CI/CD linter workflow.
370371
371372``` mermaid
372373sequenceDiagram
@@ -466,7 +467,7 @@ sequenceDiagram
466467
467468#### How linting is triggered in CI/CD
468469
469- Logically (eg. ignoring complexities of concurrency and trigger conditionals, etc.) the various
470+ Logically (e.g., ignoring complexities of concurrency and trigger conditionals, etc.) the various
470471linters are all run independently per CI/CD linter workflow.
471472
472473``` mermaid
0 commit comments