From 105db4c1fbce08770c821e836343cec235df9556 Mon Sep 17 00:00:00 2001 From: Christopher Horrell Date: Tue, 26 May 2026 00:50:17 -0400 Subject: [PATCH] docs: update AGENTS.md and README.md for recent CI changes --- AGENTS.md | 7 +++++-- README.md | 2 +- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 2f54a0a..aca21df 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -49,10 +49,12 @@ ENTRYPOINT ["/bin/node"] - Builds and publishes to Docker Hub and GitHub Container Registry - Tags with version, major version, and "current" -### checkshell.yml +### linting.yml -- Validates shell script formatting with shfmt +- Runs on all pull requests +- Validates shell script formatting with shfmt (direct binary, not Docker) - Runs shellcheck for shell script linting +- Runs markdownlint-cli2 for Markdown linting ## Scripts @@ -80,6 +82,7 @@ Checks for new Node.js versions to build: ## Code Quality +- **Workflow Security:** All workflows under `.github/` must pass a [zizmor](https://docs.zizmor.sh/) audit (`zizmor .github/workflows/`) with no unsuppressed findings before merging - **Linting & Formatting:** Enforced via Docker-based pre-commit hooks - **Pre-commit hooks:** `.pre-commit-config.yaml` enforces checks locally before commit using Docker - shellcheck on all `.sh` and `.bats` files (shell script linting) diff --git a/README.md b/README.md index ff2044a..c2f5359 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A minimal Docker image with just Node.js. ## Use the Docker Hub Image -This image is published to the GitHub Container Registry: +This image is published to Docker Hub: