Skip to content

Commit c287bdc

Browse files
authored
docs: update AGENTS.md and README.md for recent CI changes (#294)
1 parent c8eb27e commit c287bdc

2 files changed

Lines changed: 6 additions & 3 deletions

File tree

AGENTS.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,12 @@ ENTRYPOINT ["/bin/node"]
4949
- Builds and publishes to Docker Hub and GitHub Container Registry
5050
- Tags with version, major version, and "current"
5151

52-
### checkshell.yml
52+
### linting.yml
5353

54-
- Validates shell script formatting with shfmt
54+
- Runs on all pull requests
55+
- Validates shell script formatting with shfmt (direct binary, not Docker)
5556
- Runs shellcheck for shell script linting
57+
- Runs markdownlint-cli2 for Markdown linting
5658

5759
## Scripts
5860

@@ -80,6 +82,7 @@ Checks for new Node.js versions to build:
8082

8183
## Code Quality
8284

85+
- **Workflow Security:** All workflows under `.github/` must pass a [zizmor](https://docs.zizmor.sh/) audit (`zizmor .github/workflows/`) with no unsuppressed findings before merging
8386
- **Linting & Formatting:** Enforced via Docker-based pre-commit hooks
8487
- **Pre-commit hooks:** `.pre-commit-config.yaml` enforces checks locally before commit using Docker
8588
- shellcheck on all `.sh` and `.bats` files (shell script linting)

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ A minimal Docker image with just Node.js.
44

55
## Use the Docker Hub Image
66

7-
This image is published to the GitHub Container Registry:
7+
This image is published to Docker Hub:
88

99
<https://hub.docker.com/r/chorrell/node-minimal>
1010

0 commit comments

Comments
 (0)