Skip to content

docs: update README, CHANGELOG, and integration tests#190

Merged
rianjs merged 1 commit intomainfrom
docs/183-readme-changelog-tests
Mar 28, 2026
Merged

docs: update README, CHANGELOG, and integration tests#190
rianjs merged 1 commit intomainfrom
docs/183-readme-changelog-tests

Conversation

@rianjs
Copy link
Copy Markdown
Contributor

@rianjs rianjs commented Mar 28, 2026

Summary

Test plan

  • Verify only .md files changed (git diff --stat)
  • Visual review of README against jtk <cmd> --help output
  • Confirm docs: prefix -- no release triggered

Closes #183

Catches up documentation for recent features and fixes:
- README: document --fields flag, auto-pagination, fields command group,
  users get subcommand, --assignee none, multi-value --field, and
  escape sequences in comment --body
- CHANGELOG: add entries for PRs #178, #180, #182, #186-189
- integration-tests: add test cases for auto-pagination, --fields,
  users get, --assignee none, multi-value --field, and escape sequences

Closes #183
Copy link
Copy Markdown

@monit-reviewer monit-reviewer left a comment

Choose a reason for hiding this comment

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

Automated PR Review

Reviewed commit: 3f2c9b0

Approved with 3 non-blocking suggestions below. Address at your discretion.

Summary

Reviewer Findings
harness-engineering:architecture-reviewer 1
harness-engineering:knowledge-reviewer 1
harness-engineering:legibility-reviewer 1
harness-engineering:architecture-reviewer (1 findings)

💡 Suggestion - tools/jtk/integration-tests.md:161

Auto-pagination test #1 expects 'Number >= 101 (proves multi-page fetch)' but the note says to lower --max if the project has fewer than 100 issues. If --max is lowered, the expected output comment '>=101' becomes invalid. Consider parameterizing the expected output to match the adjusted scenario (e.g., 'Number >= --max value').

harness-engineering:knowledge-reviewer (1 findings)

💡 Suggestion - tools/jtk/integration-tests.md:410

Steps 6b, 11b, and 11c use lettered sub-step numbering that breaks the sequential flow used everywhere else in the checklist. Consider renumbering as proper sequential steps (e.g., 6b becomes 7, shift subsequent) or using sub-bullets under the parent step.

harness-engineering:legibility-reviewer (1 findings)

💡 Suggestion - tools/jtk/README.md:13

Feature list entry 'Manage custom fields (create, delete, restore, contexts, options)' omits 'list' operation. Adjacent entries like 'Manage automation rules (list, export, create, enable/disable)' include it. Consider adding 'list' for consistency.

2 info-level observations excluded. Run with --verbose to include.


Completed in 3m 01s | $0.41
Field Value
Reviewers hybrid-synthesis, harness-engineering:knowledge-reviewer, harness-engineering:enforcement-reviewer, harness-engineering:architecture-reviewer, harness-engineering:legibility-reviewer
Reviewed by pr-review-daemon · monit-pr-reviewer
Duration 3m 01s (Reviewers: 1m 10s · Synthesis: 46s)
Cost $0.41
Tokens 90.9k in / 13.7k out
Turns 5

Expected: `✓ Assigned issue $TEST_ISSUE to YOUR_NAME`

6. **Add comment:**
6. **Add comment with escape sequences:**
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔵 Low (harness-engineering:knowledge-reviewer): Steps 6b, 11b, and 11c use lettered sub-step numbering that breaks the sequential flow used everywhere else in the checklist. Consider renumbering as proper sequential steps (e.g., 6b becomes 7, shift subsequent) or using sub-bullets under the parent step.

| 3 | `jtk issues search --jql "project = $PROJECT AND summary ~ 'xyznonexistent999'"` | `No issues found` |
| 4 | `jtk issues search --jql "invalid jql ((("` | `bad request: Error in the JQL Query: ...` |

### Auto-pagination (issues search / issues list)
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔵 Low (harness-engineering:architecture-reviewer): Auto-pagination test #1 expects 'Number >= 101 (proves multi-page fetch)' but the note says to lower --max if the project has fewer than 100 issues. If --max is lowered, the expected output comment '>=101' becomes invalid. Consider parameterizing the expected output to match the adjusted scenario (e.g., 'Number >= --max value').

- Manage sprints and boards
- Add comments and perform transitions
- Manage attachments
- Manage custom fields (create, delete, restore, contexts, options)
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔵 Low (harness-engineering:legibility-reviewer): Feature list entry 'Manage custom fields (create, delete, restore, contexts, options)' omits 'list' operation. Adjacent entries like 'Manage automation rules (list, export, create, enable/disable)' include it. Consider adding 'list' for consistency.

@rianjs rianjs merged commit 72edf1a into main Mar 28, 2026
7 checks passed
@rianjs rianjs deleted the docs/183-readme-changelog-tests branch March 28, 2026 18:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(jtk): true up README, CHANGELOG, and integration tests

2 participants