Skip to content

docs: add the CodeQL badge and describe code scanning #37

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
dpologdvinity merged 1 commit into from
Nov 6, 2026
Merged

docs: add the CodeQL badge and describe code scanning #37

Show file tree
Hide file tree
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: 3 additions & 1 deletion ARCHITECTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,9 @@ Coverage counts only what `go test` runs in-process. The end-to-end tests run th
they prove behavior but are not counted: `cmd/gitwhy` and `internal/ui` show 0%. Every third-party
action is pinned to a full commit SHA and every tool to an exact version; Dependabot proposes the
updates. `.github/workflows/check-secrets.yml` (manual) checks that the release secrets are set and
that the Homebrew token can write to the tap.
that the Homebrew token can write to the tap. GitHub code scanning (CodeQL default setup, managed
in the repository settings, so there is no workflow file) analyzes the Go code, the workflows, the
npm package and the Python scripts on every push and pull request to `main` and once a week.

## Build, release and packaging

Expand Down
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ node --test npm/lib.test.js # the npm package
CI (`.github/workflows/ci.yml`) is the authority. On top of the commands above it runs `govulncheck`,
`actionlint`, `shellcheck`, checks that `go.mod`/`go.sum` are tidy and that `THIRD_PARTY_LICENSES` is up
to date (`scripts/third-party-licenses.sh` regenerates it), builds every release artifact with goreleaser
in snapshot mode, and builds the Nix flake. All of it must be green before a merge.
in snapshot mode, and builds the Nix flake. GitHub code scanning (CodeQL) also runs on every pull
request. All of it must be green before a merge.

### Coverage

Expand Down
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![ci](https://github.com/dpologdvinity/gitwhy/actions/workflows/ci.yml/badge.svg)](https://github.com/dpologdvinity/gitwhy/actions/workflows/ci.yml)
[![release installs verified](https://github.com/dpologdvinity/gitwhy/actions/workflows/verify-install.yml/badge.svg)](https://github.com/dpologdvinity/gitwhy/actions/workflows/verify-install.yml)
[![CodeQL](https://github.com/dpologdvinity/gitwhy/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/dpologdvinity/gitwhy/security/code-scanning)
[![latest release](https://img.shields.io/github/v/release/dpologdvinity/gitwhy)](https://github.com/dpologdvinity/gitwhy/releases/latest)
[![npm](https://img.shields.io/npm/v/@kaitlynbassford/gitwhy)](https://www.npmjs.com/package/@kaitlynbassford/gitwhy)
[![downloads](https://img.shields.io/github/downloads/dpologdvinity/gitwhy/total)](https://github.com/dpologdvinity/gitwhy/releases)
Expand Down
Loading