Skip to content

Capture help output for docs - #12248

Merged
mergify[bot] merged 1 commit into
haskell:masterfrom
cabalism:doc/cmd-help
Aug 23, 2026
Merged

Capture help output for docs#12248
mergify[bot] merged 1 commit into
haskell:masterfrom
cabalism:doc/cmd-help

Conversation

@philderbeast

@philderbeast philderbeast commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

Preparation for #5607, adding optparse-applicative. Adds makefile rules for generating on disk text files with command help content. I've put these in the doc folder since they're a useful reference when working on the user manual. I've added a workflow, with path checks, that I'll use to confirm that the command help output is not changed by using optparse-applicative for rendering the command help.

I'll squash commits before applying the merge label if this pull request is approved.

Caution

Attaching the new AI-assisted label, the workflow, .github/workflows/cmd-help.yml, was generated.


  • Patches conform to the coding conventions.
  • Is this a PR that fixes CI? If so, it will need to be backported to older cabal release branches (ask maintainers for directions).

@Mikolaj Mikolaj left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds like a good idea.

- Strip absolute path from help.txt
- Reproduce and mitigate failure locally .DELETE_ON_ERROR
- Remove build step, run is enough
- Setup.hs copy output has bad ending
@philderbeast philderbeast added merge me Tell Mergify Bot to merge AI-assisted and removed attention: needs-review labels Aug 21, 2026
@mergify mergify Bot added ready and waiting Mergify is waiting out the cooldown period merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days queued labels Aug 21, 2026
@mergify

mergify Bot commented Aug 23, 2026

Copy link
Copy Markdown
Contributor

Merge Queue Status

This pull request spent 2 hours 9 minutes 13 seconds in the queue, including 1 hour 57 minutes 40 seconds running CI.

Required conditions to merge
  • #review-threads-unresolved = 0 [🛡 GitHub branch protection]
  • github-review-approved [🛡 GitHub branch protection]
  • any of [🛡 GitHub branch protection]:
    • check-success = Doctest Cabal
    • check-neutral = Doctest Cabal
    • check-skipped = Doctest Cabal
  • any of [🛡 GitHub branch protection]:
    • check-success = Meta checks
    • check-neutral = Meta checks
    • check-skipped = Meta checks
  • any of [🛡 GitHub branch protection]:
    • check-success = docs/readthedocs.org:cabal
    • check-neutral = docs/readthedocs.org:cabal
    • check-skipped = docs/readthedocs.org:cabal
  • any of [🛡 GitHub branch protection]:
    • check-success = Validate post job
    • check-neutral = Validate post job
    • check-skipped = Validate post job
  • any of [🛡 GitHub branch protection]:
    • check-success = fourmolu
    • check-neutral = fourmolu
    • check-skipped = fourmolu
  • any of [🛡 GitHub branch protection]:
    • check-success = hlint
    • check-neutral = hlint
    • check-skipped = hlint
  • any of [🛡 GitHub branch protection]:
    • check-success = Bootstrap post job
    • check-neutral = Bootstrap post job
    • check-skipped = Bootstrap post job
  • any of [🛡 GitHub branch protection]:
    • check-success = whitespace
    • check-neutral = whitespace
    • check-skipped = whitespace
  • any of [🛡 GitHub branch protection]:
    • check-success = Check sdist post job
    • check-neutral = Check sdist post job
    • check-skipped = Check sdist post job
  • any of [🛡 GitHub branch protection]:
    • check-success = Changelogs
    • check-neutral = Changelogs
    • check-skipped = Changelogs

@mergify
mergify Bot merged commit a0c8112 into haskell:master Aug 23, 2026
96 of 98 checks passed
@mergify mergify Bot removed the queued label Aug 23, 2026
@ffaf1 ffaf1 mentioned this pull request Aug 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AI-assisted merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days merge me Tell Mergify Bot to merge ready and waiting Mergify is waiting out the cooldown period

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants