Update the issue-tracker doc for zfj's new close, reopen, label and pr commands #22
Labels
No labels
needs-info
needs-triage
ready-for-agent
ready-for-human
wayfinder:map
wayfinder:task
wontfix
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
jeff/harrier#22
Loading…
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
docs/agents/issue-tracker.mdis written for zfj 0.4.0, and describes workarounds for gaps that zfj has since filled. These changes are on zfj'smain(git.jcollie.dev/jeff/zfj, up to d8e4c7d) but not yet in a release. Update the doc once a zfj with them is what harrier's sessions run, and change "written for zfj 0.4.0" to that version.What changed in zfj
issue closetakes a comment (jeff/zfj#22):zfj issue close <n> -c "<why>", or-F <file>; either takes-for stdin. The comment is posted first, then the issue is closed. The doc's "closetakes no comment, so leave the closing comment withissue commentfirst" can go.issue reopen(jeff/zfj#23):zfj issue reopen <n> [-c <text> | -F <file>].zfj label list [--json]andzfj label create <name> -c <hex> [-d <description>] [--force] [--json].createrefuses a name that already exists (exit 2), since Forgejo would otherwise allow duplicates;--forceupdates the existing label's color and description instead. This replaces theop issueCreateLabelrecipe.issue view --web(jeff/zfj#26):-w/--webopens the issue in the browser.zfj pr view <n> [--comments] [--json | --web]zfj pr list [-s open|closed|all] [-l <label>]... [-A <author>] [-B <base>] [-H <head>] [--json]. Merged pull requests show asmerged.zfj pr diff <n> [--patch]. This replaces theop repoGetPullRequestFilesrecipe.zfj pr create -t <title> [-b <text> | -F <file>] [-B <base>] [-H <head>] [-l <label>]... [-a <user>].... The head defaults to the checked-out branch, asowner:branchin a fork's clone, and the base defaults to the repository's default branch.What to change in
docs/agents/issue-tracker.mdissue close <n> -c "...".zfj label create.prcommands" is no longer true. Point atpr view --comments --json,pr listandpr diff. The claim thatcomment,edit --add-labelandclosework on a PR's number has now been tested against Forgejo 16 in zfj's VM test, so "(viewhas been tried on one; the others use the same endpoints)" can be dropped.issue commentthenissue closecan become a singleissue close <n> -c "<answer>".Done in
427e2f3: the doc is now written for zfj 0.5.0, with close/reopen taking a comment, label list/create, pr view/list/diff for triage, and Resolve as a single issue close -c. pr create and issue view --web were left out on purpose: harrier commits to main, and agents don't use a browser.