Skip to content

Update CI doc to explicitly mention gosec #1629

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 5, 2024
Merged

Update CI doc to explicitly mention gosec #1629

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/dev/ci.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down