mirror of
https://github.com/kuhyx/utils.git
synced 2026-11-10 20:07:18 +01:00
Krzysztof kuhy Rudnicki
a10d190b65
Some checks failed
file length / file-length (push) Waiting to run
md-naming / markdown naming convention (push) Waiting to run
palette drift / palette (push) Waiting to run
design_system tests / test (push) Has been cancelled
gatelock pre-commit / pre-commit (push) Has been cancelled
gatelock tests / test (3.10) (push) Has been cancelled
gatelock tests / test (3.11) (push) Has been cancelled
gatelock tests / test (3.12) (push) Has been cancelled
web_ui tests / test (push) Has been cancelled
Markdown across every repo had accumulated a dozen ad-hoc names (refactor_claude_todo.md x23, DESIGN_AUDIT_TODO.md, NEXT_SESSION, HANDOFF, PLAN, SPEC) with nothing distinguishing a live task from a finished record. An audit found docs asserting work was pending that shipped months earlier, and one asserting completion while the work was open. Four namespaces now: README.md, CLAUDE*.md, DOCS*.md, TODO*.md. Task files carry the literal "REMOVE ME AFTER FINISH" and are deleted when the work lands. Enforced bidirectionally -- a TODO without the marker fails, AND any file carrying the marker that is not named TODO*.md fails. Without the reverse rule a task can be renamed into the permanent namespace and quietly live forever, which is the failure being fixed. md_naming/ mirrors the file_length topology and imports its tables (EXCLUDED_DIRS, THIRD_PARTY_REPOS, VENDORED_ANYWHERE, GENERATED_PATTERN) rather than restating them, so the two gates cannot disagree about the same file. 71 tests, 100% branch coverage. stale.py warns on TODOs past 90 days but never fails: no machine can prove a task is finished, so the honest mechanism is a nudge. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01A47aX5DJwmA3QFn3pkEWi7
39 lines
1.3 KiB
YAML
39 lines
1.3 KiB
YAML
name: md-naming
|
|
|
|
# The four markdown namespaces, enforced on push as well as at commit time.
|
|
# The local pre-commit hook can be skipped (a fresh clone that never ran
|
|
# `pre-commit install` has no hooks at all), so the convention needs a second
|
|
# gate that no one can forget to install.
|
|
#
|
|
# Deliberately a SEPARATE workflow from any release job: a badly named doc
|
|
# should fail lint, not block publishing an artifact.
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
pull_request:
|
|
workflow_dispatch:
|
|
|
|
jobs:
|
|
md-naming:
|
|
name: markdown naming convention
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
# The gate and its exemption list live in the shared utils repo so every
|
|
# repo enforces the same namespaces. Checking it out beats vendoring a
|
|
# copy here, which is exactly how a gate and a survey start disagreeing.
|
|
- name: Check out the shared gate
|
|
uses: actions/checkout@v4
|
|
with:
|
|
repository: kuhyx/utils
|
|
path: .utils
|
|
|
|
- name: Enforce the naming convention
|
|
run: bash .utils/scripts/check_md_naming.sh --all
|
|
|
|
# Warns only: no machine can prove a task is finished, so an old TODO
|
|
# gets a nudge, never a failure.
|
|
- name: Warn about stale TODOs
|
|
run: PYTHONPATH=.utils python3 .utils/md_naming/stale.py
|