chore: normalize comment formatting in CI workflow and gitignore

Replace inconsistent hash-comment separators (using `#   ` prefix with
spaces) with a uniform dash-based style across the CI pipeline YAML
file, and add a `*.bak*` glob to the project's `.gitignore` to exclude
backup files from version control.
This commit is contained in:
retoor 2026-07-08 08:40:46 +00:00
parent a804fbe97e
commit 4a9b4bdf3a
2 changed files with 10 additions and 9 deletions

View File

@ -5,10 +5,10 @@
# Requires a Gitea act_runner with the "ubuntu-latest" label.
#
# Jobs:
# lint compilation check with strict hints/warnings
# test matrix across Nim versions; runs the full test suite
# build release-optimised binary (depends on lint + test)
# coverage instrumented test run (manual / main only)
# lint - compilation check with strict hints/warnings
# test - matrix across Nim versions; runs the full test suite
# build - release-optimised binary (depends on lint + test)
# coverage - instrumented test run (manual / main only)
# =============================================================================
name: CI
@ -25,14 +25,14 @@ concurrency:
cancel-in-progress: true
# ---------------------------------------------------------------------------
# Shared environment drive everything from a single Nim version variable
# Shared environment - drive everything from a single Nim version variable
# ---------------------------------------------------------------------------
env:
NIM_VERSION: "stable"
jobs:
# =========================================================================
# LINT compile with every hint and warning enabled so nothing slips
# LINT - compile with every hint and warning enabled so nothing slips
# through. This catches dead code, unused imports, and type issues early.
# =========================================================================
lint:
@ -65,7 +65,7 @@ jobs:
run: make lint
# =========================================================================
# TEST matrix across the minimum supported Nim version and the latest
# TEST - matrix across the minimum supported Nim version and the latest
# stable release. Runs the full test suite (all languages).
# =========================================================================
test:
@ -101,7 +101,7 @@ jobs:
run: make test
# =========================================================================
# BUILD release-optimised binary. Only runs when lint and at least one
# BUILD - release-optimised binary. Only runs when lint and at least one
# test matrix leg pass. Uploads the binary as a workflow artifact.
# =========================================================================
build:
@ -142,7 +142,7 @@ jobs:
retention-days: 7
# =========================================================================
# COVERAGE instrumented test run (requires nim-coverage; optional).
# COVERAGE - instrumented test run (requires nim-coverage; optional).
# Runs on manual dispatch or merges to main only to save CI minutes.
# =========================================================================
coverage:

1
.gitignore vendored
View File

@ -3,6 +3,7 @@
tests/test_json_exhaustive
tests/test_toml_exhaustive
tests/test_yaml_exhaustive
*.bak*
# ── Nim ──────────────────────────────────────────────────────────────────
nimcache/
nimblecache/