docs: align documentation and comments with implementation

- Use Containerfile terminology in builder.sh hadolint message
- Fix comment typos (trailing backslashes) in builder.sh and install_tools.sh
- Reorder README release workflow so hadolint runs before build
- Run hadolint with .hadolint.yaml in builder.sh to match release workflow
- Add files: ^Containerfile$ to pre-commit hadolint hook
- Add CHANGELOG.md and install-man-page.sh to project structure
- Note that local install may use different tool versions than image/CI

Co-authored-by: Cursor <cursoragent@cursor.com>

Author: miragecentury

.pre-commit-config.yaml

@@ -14,6 +14,7 @@ repos:
     hooks:
       - id: hadolint-docker
         args: ["--config", ".hadolint.yaml"]
+        files: ^Containerfile$
 
   - repo: https://github.com/shellcheck-py/shellcheck-py
     rev: v0.10.0.1

README.md

@@ -62,8 +62,8 @@ When a new version is determined, the release workflow:
 
 1. Creates a GitHub release with auto-generated notes
 2. Updates `CHANGELOG.md`
-3. Builds the image with `buildah` (OCI format, squashed layers)
-4. Runs `hadolint` lint validation
+3. Validates the Containerfile with hadolint
+4. Builds the image with `buildah` (OCI format, squashed layers)
 5. Runs `dive` filesystem efficiency scan
 6. Runs `trivy` vulnerability scan (HIGH/CRITICAL)
 7. Pushes to GHCR with semver tags: `1.2.3`, `1.2`, `1`, `latest`
@@ -87,6 +87,8 @@ Install [Docker](https://docs.docker.com/get-docker/), then install the build to
 ./scripts/install_tools.sh
 ```
 
+Local install may use different (e.g. latest) versions for some tools than the pinned versions in the image and CI.
+
 ### Configuration
 
 Build configuration is defined in `manifest.yaml`:
@@ -177,6 +179,8 @@ git commit -m "WIP"
 .
 ├── Containerfile                        # Multi-stage container definition
 ├── manifest.yaml                        # Build configuration and metadata
+├── CHANGELOG.md                         # Generated by semantic-release
+├── install-man-page.sh                  # Optional: install yq man page locally
 ├── .releaserc.yaml                      # Semantic release configuration
 ├── .hadolint.yaml                       # Hadolint configuration
 ├── .commitlintrc.yaml                   # Commitlint configuration

scripts/builder.sh

@@ -47,13 +47,13 @@ clean_build_dir(){
 hadolint_validate(){
     local hadolint_exec
     local hadolint_exit_code
-    log_info "Validating Dockerfile with hadolint"
+    log_info "Validating Containerfile with hadolint"
     ${CLI} pull -q ghcr.io/hadolint/hadolint:latest > /dev/null
     log_trace "$(${CLI} run --rm -i hadolint/hadolint:latest hadolint -v)"
 
     set +e
     hadolint_exec=$(
-        ${CLI} run --rm -i hadolint/hadolint:latest < Containerfile \
+        ${CLI} run --rm -i -v "$(pwd)/.hadolint.yaml:/.hadolint.yaml:ro" hadolint/hadolint:latest hadolint --config /.hadolint.yaml - < Containerfile \
             2>&1
     )
     hadolint_exit_code=$?
@@ -312,7 +312,7 @@ trivy_scan () {
 
 # Main
 clean_build_dir
-check_for_manifest # Check for manifest file existence\
+check_for_manifest # Check for manifest file existence
 IMAGE_NAME=$(retrieve_name_from_manifest) # Retrieve image name from manifest
 
 log_info "Starting build process"

scripts/install_tools.sh

@@ -27,7 +27,7 @@ sudo apt-get install trivy -y
 # Install buildah
 sudo apt-get install buildah -y
 
-# Install yq\
+# Install yq
 VERSION="v4.45.4"
 BINARY="yq_linux_amd64"
 wget https://github.com/mikefarah/yq/releases/download/${VERSION}/${BINARY}.tar.gz -O - |\