Sign in

Search issue titles and bodies, change requests and comments. Private repositories you cannot read are not included.
vole
Clone

Read only, no credentials:

https://rodent.software/vole.git

Write over SSH with a registered key:

git clone ssh://git@rodent.software:2222/vole.git

A free and open-source forge that lives in your Git repo.

#31

Document how a change request links the issues it closes

merged · by keenan 13d ago · merged into main at b7ac1a00 by keenan 13d ago

keenan opened this 13d ago

Yes — the flag exists but none of the guides mentioned it.

Why

A change request links an issue through its own metadata: request.md has a closes list, set with vole change new --closes <issue> or vole change update <id> --closes <issue> while the request is open. That list is what the request page shows and what landing the request closes.

None of the documentation said so. docs/cli.md listed neither flag, docs/change-requests.md never mentioned the field, and CONTRIBUTING.md showed the opening command without it — so Fixes #<ulid> in a description looks like it links the issue while closing nothing. The command’s own usage text was the only place the flag appeared.

What changed

  • docs/change-requests.md: request.md’s shape now names closes, the opening example passes --closes, change update’s synopsis includes the link flags, and a new Linking the issues it closes section covers setting it at open or later, replacing rather than appending, full ids that must exist, the browser form’s Closes field, and that landing is what closes an issue.
  • docs/cli.md: the change new and change update synopses take [--closes <issue>]... / [--no-closes], with one sentence on what they do.
  • CONTRIBUTING.md: the change-request example passes --closes, and the prose Fixes #<ulid> form is called out as text that links nothing.

No behaviour changes. Found while opening change request #01M5XM4H99DZ71VTJC8YWYS1CC, whose issue link was recorded after the fact with vole change update.

Checks

  • python3 scripts/check-links.py
  • vole workflow run verify (the docs are covered by the link check; the code is untouched)

Discussion (0)

No discussion yet.