From 62da5380655c253a9403481985f2be3dda57b446 Mon Sep 17 00:00:00 2001 From: grego952 Date: Thu, 25 Jan 2024 08:24:51 +0100 Subject: [PATCH] Add testing strategy --- docs/contributor/testing-strategy.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 docs/contributor/testing-strategy.md diff --git a/docs/contributor/testing-strategy.md b/docs/contributor/testing-strategy.md new file mode 100644 index 00000000..d0f0fd75 --- /dev/null +++ b/docs/contributor/testing-strategy.md @@ -0,0 +1,16 @@ +# Testing Strategy + +Each pull request to the repository triggers the following CI/CD jobs: + +- `golangci-lint / lint (pull_request)` - Is responsible for linting and static code analysis. +- `PR Markdown Link Check / markdown-link-check (pull_request)` - Checks if there are no broken links in the pull request `.md` files. +- `Run unit tests / validate (pull_request)` - Executes basic create/update/delete functional tests of the reconciliation logic. +- `Run vuln check / test (pull_request)` - Executes the [govulncheck](https://pkg.go.dev/golang.org/x/vuln/cmd/govulncheck) tool on the code to detect known vulnerabilities. +- `pull-infrastructure-manager-build` - builds the Docker image and pushes it to the registry. + +After the pull request is merged, the following CI/CD jobs are executed: + + - `Run unit tests / validate (push)` - Executes basic create/update/delete functional tests of the reconciliation logic. + - `Run vuln check / test (push)` - Executes the [govulncheck](https://pkg.go.dev/golang.org/x/vuln/cmd/govulncheck) tool on the code to detect known vulnerabilities. + - `golangci-lint / lint (push)` - Is responsible for linting and static code analysis. + - `main-infrastructure-manager-build` - Rebuilds the image and pushes it into the `prod` registry. \ No newline at end of file