From 732c0011940524d65edd414aa716ea7a137b4a56 Mon Sep 17 00:00:00 2001 From: Roo Thorp Date: Tue, 4 Jun 2024 13:35:45 +0100 Subject: [PATCH] update ci doc to explicitly mention gosec --- docs/dev/ci.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/dev/ci.md b/docs/dev/ci.md index 3206b96f84..347efa6dcf 100644 --- a/docs/dev/ci.md +++ b/docs/dev/ci.md @@ -51,9 +51,9 @@ The [test.yml](../../.github/workflows/test.yml) workflow takes the output from ### Linting -The lint workflow runs three seperate linters; `golangci` (via `make lint`, `shellcheck`, and `govulncheck`. +The lint workflow runs three seperate linters; `golangci` (via `make lint`), `shellcheck`, and `govulncheck`. -`golangci` is a tool that makes use of a defined collection of other linters. The enabled linters (and other configuration) for `golangci` can be seen in [this repo's config file](../../.golangci.yml). +`golangci` is a tool that makes use of a defined collection of other linters, such as `gosec` and `govet`. The enabled linters (and other configuration) for `golangci` can be seen in [this repo's config file](../../.golangci.yml). `shellcheck` lints shell scripts in the repo. This is performed with default settings, using [`shellcheck-action`](https://github.com/bewuethr/shellcheck-action). This tool makes use of a regex to find all files within the codebase that have shell scripts that should be assessed.