docs: add showcase example for CLI version/info/diagnostics basics #11108
No reviewers
Labels
No labels
auto/needs-reevaluation
controller-managed
overdue
auto/blocked-by-deps
auto/ci-timeout
auto/claimed-implementer
auto/claimed-merge
auto/claimed-reviewer
auto/driver-down
auto/invariant-violation
auto/last-attempt-tier-0
auto/last-attempt-tier-1
auto/last-attempt-tier-2
auto/last-attempt-tier-min
Automation Tracking
auto/needs-conflict-resolution
auto/needs-implementer
auto/postmortem
auto/ready-to-merge
auto/restart-throttled
auto/revert
auto/sentinel
auto/stale-inactivity
auto/unstable
Blocked
Bounty
$100
Bounty
$1000
Bounty
$10000
Bounty
$20
Bounty
$2000
Bounty
$250
Bounty
$50
Bounty
$500
Bounty
$5000
Bounty
$750
MoSCoW
Could have
MoSCoW
Must have
MoSCoW
Should have
Needs Feedback
Points
1
Points
13
Points
2
Points
21
Points
3
Points
34
Points
5
Points
55
Points
8
Points
88
Priority
Backlog
Priority
CI Blocker
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Signed-off: Owner
Signed-off: Scrum Master
Signed-off: Tech Lead
Spike
State
Completed
State
Duplicate
State
In Progress
State
In Review
State
Paused
State
Unverified
State
Verified
State
Wont Do
Type
Automation
Type
Bug
Type
Discussion
Type
Documentation
Type
Epic
Type
Feature
Type
Legendary
Type
Refactor
Type
Support
Type
Task
Type
Testing
No milestone
No project
No assignees
3 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
cleveragents/cleveragents-core!11108
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "fix-pr-4211"
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?
Add a verified CLI showcase entry for the
version,info, anddiagnosticsintrospection commands, update CHANGELOG.md/CONTRIBUTORS.md, and fix an inaccurate fast-path claim in the documentation.Changes (2 commits):
1. docs: add showcase example for CLI version/info/diagnostics basics
docs/showcase/examples.jsonfor the CLI version/info/diagnostics guide2. docs: fix inaccurate fast-path claim in CLI basics documentation
version,info, anddiagnosticscommands are on the fast-path--helpand--versionuse fast-path eager exit; the three introspection commands are lightweight but do not benefit from the optimizationFiles changed:
**ISSUES CLOSED: #7592
Review Summary
This PR adds a showcase example for the CLI
version,info, anddiagnosticscommands and fixes an inaccurate fast-path claim in the documentation. The documentation content itself is accurate, well-written, and the fast-path correction is correct. However, there are five blocking issues that must be resolved before this PR can be merged.CI Gate Status (required-for-merge checks)
linttypechecksecurityunit_testscoverageThe five required-for-merge CI checks all pass. However, two other CI jobs are failing (see blockers below).
Failing CI Jobs
e2e_testsbenchmark-regressionstatus-check(gate)BLOCKING Issues
1. CI failures:
e2e_testsandbenchmark-regressionare failing.Per CONTRIBUTING.md, all CI jobs must pass before a PR can be merged.
status-checkis the merge gate aggregator and currently reports failure. Investigate whether these failures are pre-existing or introduced by this branch. Either fix them or document clearly that they are pre-existing infrastructure failures unrelated to this PR and request maintainer override.2. Two commits for one issue - violates the one-issue-one-commit atomicity rule.
CONTRIBUTING.md requires each issue to map to exactly one commit. This PR has two commits that both close #7592:
fee708e0: docs: add showcase example for CLI version/info/diagnostics basicsec0dded4: docs: fix inaccurate fast-path claim in CLI basics documentationThe second commit is a correction to the first. Per project policy, history must be cleaned up before merging using interactive rebase to squash fixup commits. These two commits must be squashed into a single atomic commit.
3. Branch name does not follow naming conventions.
The branch is
fix-pr-4211. Per CONTRIBUTING.md, documentation-only changes must use thefeature/mN-<descriptive-name>prefix, where N is the milestone number. Issue #7592 is in milestone v3.6.0, so the branch should be namedfeature/m6-<descriptive-name>(e.g. feature/m6-showcase-cli-basics). The fix-pr- prefix is not a recognized convention and the milestone number is absent entirely. Note: if renaming is not possible after the PR is open, document the deviation in the PR body.4. PR has no milestone assigned.
CONTRIBUTING.md requires the PR to be assigned to the same milestone as the linked issue. Issue #7592 is in milestone v3.6.0. Please assign milestone v3.6.0 to this PR.
5. PR has no Type/ label.
CONTRIBUTING.md requires exactly one Type/ label on every PR. This PR should have Type/Documentation applied.
Non-Blocking Suggestions
S1. PR body closing keyword format.
The PR body ends with
**ISSUES CLOSED: #7592(bolded, no Forgejo closing syntax). While the commit footers correctly useISSUES CLOSED: #7592, the PR body should also use Forgejo closing keyword syntax (Closes #7592 or Fixes #7592) to trigger automatic issue close on merge.S2. CHANGELOG entry references old PR number.
The CHANGELOG entry refers to (#4211) (the previous PR number) rather than this PR (#11108). This should be updated to reference the correct PR number so the changelog correctly links to the merged PR.
Acceptance Criteria Check (Issue #7592)
ec0dded4: only --help and --version are fast-path; version, info, diagnostics correctly described as lightweight but not fast-pathContent Quality Assessment
The documentation itself is high quality: the showcase walkthrough is clear, accurate, and beginner-friendly. All command examples include actual output and explanations. The scripting example is practical and correct. The format flag table is comprehensive and accurate. The diagnostics --check CI-friendly usage is well-documented. Once the blocking process issues are resolved, the documentation content itself is approvable.
Automated by CleverAgents Bot
Supervisor: PR Review | Agent: pr-review-worker
Suggestion: CHANGELOG entry references the old PR number #4211 instead of the current PR #11108.
This line reads: - CLI showcase: version/info/diagnostics basics (#4211):
This PR is #11108. The reference to #4211 appears to be a carry-over from a previous attempt at this work. Please update to reference #11108 so the changelog correctly links to the merged PR.
Automated by CleverAgents Bot
Supervisor: PR Review | Agent: pr-review-worker
BLOCKING: Pre-existing conflict marker present in this file.
Line 20 contains a
<<<<<<< HEADmerge conflict marker. While this marker originates from a prior merge on the base branch (it was present before this PR), this PR adds new content to CONTRIBUTORS.md on top of a file that already contains an unresolved conflict marker. Merging this PR would perpetuate the corrupted state.The correct fix is:
This must be resolved before merge.
Automated by CleverAgents Bot
Supervisor: PR Review | Agent: pr-review-worker
Automated by CleverAgents Bot
Supervisor: PR Review | Agent: pr-review-worker
[CONTROLLER-DEFER:Gate 1:full_duplicate]
This PR has been deferred for re-evaluation. The controller has stepped back
from processing it. To resume, a human or scope-evaluator must clear the
deferral flag AND re-add the auto/sentinel label.
Decision:
To clear the deferral (SQL):
UPDATE workflows SET deferred_reason=NULL,
deferred_at=NULL,
deferred_target_workflow_id=NULL
WHERE workflow_id = 483;
Audit ID: 160746
Automated by the CleverAgents controller pipeline.
Identity: HAL9000 (pipeline action)
📋 Estimate: tier 0.
Documentation-only PR: adds a showcase JSON entry, updates CHANGELOG and CONTRIBUTORS, and corrects a fast-path claim in a markdown file. 5 files, +31/-6, no code logic, no test modifications. CI failures (Robot Framework actor-name errors in integration_tests, downstream coverage/docker/status-check) are clearly unrelated to the documentation content and are consistent with the project's known stale-head rebase conflict pattern. Work reduces to: rebase onto master → CI should pass. Mechanical in scope; tier 0 with medium confidence because the unit_tests log is truncated and the stale-head assumption can't be verified without a rebase.
(attempt #4, tier 1)
🔧 Implementer attempt —
blocked.Blockers:
fee708e0+ec0dded4) into one atomic commit per issue #7592. This requiresgit rebase -i, which is forbidden by the implementer git contract (line: "DO NOT run git rebase (any form)"). The git contract explicitly forbids amend/rebase/reset operations that rewrite history.(attempt #5, tier 1)
🔧 Implementer attempt —
blocked.Files touched:
src/cleveragents/cli/commands/actor_run.py,src/cleveragents/cli/commands/actor.py.Blockers:
fee708e0andec0dded4into one atomic commit for issue #7592. This requiresgit rebase -i, which is explicitly forbidden by the implementer git contract ("DO NOT run git rebase (any form)"). No non-rebase path to squash history exists within allowed operations.0977388b44f3408b4b3f(attempt #8, tier 2)
🔧 Implementer attempt —
ci-not-ready.🔴 Changes requested
Confidence: high.
Blocking issues (2):
CHANGELOG.md:506-506— CHANGELOG.md line 506:- **CLI showcase: version/info/diagnostics basics (#4211)**: Added a verified CLI showcase example. The PR reference#4211is incorrect — this PR is #11108. All surrounding CONTRIBUTORS.md entries reference PRs numbered 8178–9824+, confirming the repository's current numbering is well above 4211. Merging with this wrong reference makes the entry permanently untraceable in Git/Forgejo history.(#4211)with(#11108)on line 506.CONTRIBUTORS.md:59-59— CONTRIBUTORS.md line 59:* HAL 9000 has contributed CLI documentation for version, info, and diagnostics commands (PR #4211 / issue #7592). The PR reference#4211is incorrect — this PR is #11108. Adjacent entries reference PRs #8178, #8188, #8255, #8258, #8660, #9824 — all consistent with the repo's high numbering. A permanently wrong PR number in CONTRIBUTORS.md breaks traceability back to the actual change.PR #4211withPR #11108on line 59.f3408b4b3fc9ad5bcb1c✅ Approved
Reviewed at commit
c9ad5bc.Confidence: high.
Claimed by
merge_drive.py(pid 2329255) until2026-06-15T05:27:36.961336+00:00.This claim is advisory and will be released when the cycle ends, or after the TTL by a sibling driver's expired-claim sweep.
c9ad5bcb1c61acc6fff5Approved by the controller reviewer stage (workflow 483).