Skip to content

Commit c2c4c8e

Browse files
committed
docs: CI/CD used tools, workflow & indexing
1 parent 845cc89 commit c2c4c8e

3 files changed

Lines changed: 13 additions & 6 deletions

File tree

.github/workflows/RunE2eTests.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
# This workflow will build a .NET project
2-
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-net
3-
41
name: Run e2e tests
52

63
on: workflow_dispatch

.github/workflows/RunUnitAndIntegrationTests.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
# This workflow will build a .NET project
2-
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-net
3-
41
name: Run unit & integration tests
52

63
on:

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,19 @@ Conventions:
6363
- **Test API**: any test code that serves the purpose of making tests easier, more readable or maintainable in general by encapsulating knowledge or boilerplate code.
6464
- It may well be synonym of `test helpers`, `test utils`, etc.
6565

66+
# Continuous Integration & Continuous Deployment (CI/CD) pipelines
67+
68+
## Tools
69+
Since this project is hosted in GitHub, that the CI/CD pipelines requirements are quite simple and due to my familiarity with the tool, I've decided to use GitHub Actions.
70+
71+
## Workflow
72+
73+
The idea, is that after each `git push`, the CI pipelines are triggered in order to verify that all the projects in the solution successfully build and passes their tests. If, on the contrary, any pipeline fails, I [stop&fix](https://martinfowler.com/articles/continuousIntegration.html) to return to a healthy state as soon as possible (see _Continuous Delivery, Jez Humble and Dave Farley (2010)_).
74+
75+
## Pipelines
76+
77+
They are under `/.github/workflows/`.
78+
6679
# General decisions
6780

6881
Many of the design choices, naming, not making extensive documentation on APIs (or public members, of any sort), have been taken with the idea that this is "pet project", and that my default and preferred way of working is collaboratively with practices like pair and ensemble programing. In this scenario, unless stated otherwise to avoid interruption of flow, discussions occur on the go and decisions are taken withing seconds (as well as code reviews). Also, knowledge silos are mostly mitigated in this way.

0 commit comments

Comments
 (0)