barrettruth/delta
1
0
Fork 0
Code Issues 6 Pull requests 1 Releases 3 Packages Activity Actions

tooling: verify generated CLI manpage drift #378

Merged
barrettruth merged 1 commit from issue-362-manpage-drift into main 2026-05-11 21:25:09 +00:00
Conversation 0 Commits 1 Files changed 4 +87 -4
barrettruth commented 2026-05-11 21:18:12 +00:00
Owner
Copy link

Problem

version:check only verified the generated CLI manpage version line, so body drift between cli/man/delta.1.md and cli/man/delta.1 could pass.

Solution

  • Render cli/man/delta.1.md to a temporary manpage during version:check.
  • Compare the rendered output with tracked cli/man/delta.1 after the existing version-line check.
  • Keep build:man deterministic by passing the same explicit manpage date used by the tracked output.
  • Cover the drift comparison helper in focused tests.

Verification

  • nix develop --command pnpm vitest run tests/core/versioning-lib.test.ts tests/core/versioning.test.ts --reporter=verbose
  • nix develop --command pnpm --dir cli build:man
  • nix develop --command pnpm version:check
  • nix develop --command just lint
  • nix develop --command just test
  • nix develop --command just build

Closes #362
Parent #355

## Problem `version:check` only verified the generated CLI manpage version line, so body drift between `cli/man/delta.1.md` and `cli/man/delta.1` could pass. ## Solution - Render `cli/man/delta.1.md` to a temporary manpage during `version:check`. - Compare the rendered output with tracked `cli/man/delta.1` after the existing version-line check. - Keep `build:man` deterministic by passing the same explicit manpage date used by the tracked output. - Cover the drift comparison helper in focused tests. ## Verification - `nix develop --command pnpm vitest run tests/core/versioning-lib.test.ts tests/core/versioning.test.ts --reporter=verbose` - `nix develop --command pnpm --dir cli build:man` - `nix develop --command pnpm version:check` - `nix develop --command just lint` - `nix develop --command just test` - `nix develop --command just build` Closes #362 Parent #355
tooling: check cli manpage drift
All checks were successful
quality / Test (pull_request) Successful in 16s
Details
quality / Lint (pull_request) Successful in 21s
Details
quality / Build (pull_request) Successful in 42s
Details
2c49991bd9
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
bug
Something isn't working

  
documentation
Improvements or additions to documentation

  
duplicate
This issue or pull request already exists

  
enhancement
New feature or request

  
good first issue
Good for newcomers

  
help wanted
Extra attention is needed

  
invalid
This doesn't seem right

  
question
Further information is requested

  
status:blocked
Blocked on a decision, credential, or external dependency

  
track:api
API layer track

  
track:auto
Automation track

  
track:core
Core engine track

  
track:deploy
Deployment track

  
track:infra
Infrastructure track

  
track:ui
Web UI track

  
type:cleanup
Small cleanup, polish, or consolidation work

  
type:docs
Documentation and operator guidance

  
type:epic
Umbrella issue that coordinates related work

  
type:release
Release, packaging, and versioning work

  
type:research
Decision or investigation work before implementation

  
wontfix
This will not be worked on

No labels
bug
documentation
duplicate
enhancement
good first issue
help wanted
invalid
question
status:blocked
track:api
track:auto
track:core
track:deploy
track:infra
track:ui
type:cleanup
type:docs
type:epic
type:release
type:research
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
barrettruth/delta!378
No description provided.