rodin/review-bot
2
1
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases 6 Wiki Activity

docs(#125): update CLI example to use --vcs-url #128

Merged
rodin merged 1 commits from fix/125-readme-cli-example into main 2026-05-14 07:08:16 +00:00
Conversation 4 Commits 1 Files Changed 1
+1 -1
rodin commented 2026-05-14 06:50:40 +00:00
Owner
Copy Link
Copy Source

Summary

Fixes the remaining documentation gap from issue #125.

PR #126 renamed GITEA_URL to VCS_URL in code, action YAML, and the env var table in README.md, but the CLI usage example still showed --gitea-url.

Change

  • Update README.md CLI example: --gitea-url → --vcs-url

Completion Checklist

From PLAN-125.md:

  • VCS_URL is read first; GITEA_URL is fallback with deprecation warning (done in #126)
  • --vcs-url flag is primary; --gitea-url is deprecated alias with warning (done in #126)
  • Error message references --vcs-url not --gitea-url (done in #126)
  • action.yml passes VCS_URL to the binary (done in #126)
  • ci.yml passes VCS_URL to the binary (done in #126)
  • README updated in CLI example and env var table ← this PR
  • Integration tests use INTEGRATION_VCS_URL (done in #126)
  • go test ./... passes
  • go vet ./... passes
  • go build ./cmd/review-bot succeeds

Closes #125

## Summary Fixes the remaining documentation gap from issue #125. PR #126 renamed `GITEA_URL` to `VCS_URL` in code, action YAML, and the env var table in README.md, but the CLI usage example still showed `--gitea-url`. ## Change - Update README.md CLI example: `--gitea-url` → `--vcs-url` ## Completion Checklist From PLAN-125.md: - [x] `VCS_URL` is read first; `GITEA_URL` is fallback with deprecation warning (done in #126) - [x] `--vcs-url` flag is primary; `--gitea-url` is deprecated alias with warning (done in #126) - [x] Error message references `--vcs-url` not `--gitea-url` (done in #126) - [x] `action.yml` passes `VCS_URL` to the binary (done in #126) - [x] `ci.yml` passes `VCS_URL` to the binary (done in #126) - [x] README updated in CLI example and env var table ← **this PR** - [x] Integration tests use `INTEGRATION_VCS_URL` (done in #126) - [x] `go test ./...` passes - [x] `go vet ./...` passes - [x] `go build ./cmd/review-bot` succeeds Closes #125
rodin added 1 commit 2026-05-14 06:50:41 +00:00
docs(#125): update CLI example to use --vcs-url instead of deprecated --gitea-url
CI / test (pull_request) Successful in 18s
Details
CI / review (anthropic--claude-4.6-sonnet, sonnet, SONNET_REVIEW_TOKEN) (pull_request) Successful in 22s
Details
CI / review (gpt-5, security, ., rodin/security-patterns, SECURITY_REVIEW.md, SECURITY_REVIEW_TOKEN) (pull_request) Successful in 25s
Details
CI / review (gpt-5, gpt, GPT_REVIEW_TOKEN) (pull_request) Successful in 34s
Details
CI / test (push) Successful in 21s
Details
CI / review (anthropic--claude-4.6-sonnet, sonnet, SONNET_REVIEW_TOKEN) (push) Has been skipped
Details
CI / review (gpt-5, gpt, GPT_REVIEW_TOKEN) (push) Has been skipped
Details
CI / review (gpt-5, security, ., rodin/security-patterns, SECURITY_REVIEW.md, SECURITY_REVIEW_TOKEN) (push) Has been skipped
Details
d3bb83a10a
rodin commented 2026-05-14 06:51:13 +00:00
Author
Owner
Copy Link
Copy Source

Self-review: PASS

No issues found — ready for human review.

Change: One-line doc fix — --gitea-url → --vcs-url in README CLI example.

Verified:

  • go build ./cmd/review-bot ✅
  • go vet ./... ✅
  • go test ./... ✅
  • No other stale --gitea-url references remain in README
## Self-review: PASS No issues found — ready for human review. **Change**: One-line doc fix — `--gitea-url` → `--vcs-url` in README CLI example. **Verified**: - `go build ./cmd/review-bot` ✅ - `go vet ./...` ✅ - `go test ./...` ✅ - No other stale `--gitea-url` references remain in README
rodin added the self-reviewedready labels 2026-05-14 06:51:18 +00:00
aweiker was assigned by rodin 2026-05-14 06:51:18 +00:00
sonnet-review-bot approved these changes 2026-05-14 06:51:21 +00:00
sonnet-review-bot left a comment
First-time contributor
Copy Link
Copy Source

Sonnet Review

Summary

Single-line documentation fix replacing the deprecated --gitea-url flag with --vcs-url in the CLI usage example. CI passed and the change is correct.

Recommendation

APPROVE — Approve. This is a minimal, correct documentation update that completes the migration from --gitea-url to --vcs-url in the README CLI example. CI passed, the change is consistent with the rest of the renamed env var table already present in the README, and no code is affected.

Review by sonnet

Evaluated against d3bb83a1

# Sonnet Review ## Summary Single-line documentation fix replacing the deprecated `--gitea-url` flag with `--vcs-url` in the CLI usage example. CI passed and the change is correct. ## Recommendation **APPROVE** — Approve. This is a minimal, correct documentation update that completes the migration from `--gitea-url` to `--vcs-url` in the README CLI example. CI passed, the change is consistent with the rest of the renamed env var table already present in the README, and no code is affected. --- *Review by sonnet* <!-- review-bot:sonnet --> --- *Evaluated against d3bb83a1*
security-review-bot requested review from security-review-bot 2026-05-14 06:51:25 +00:00
security-review-bot approved these changes 2026-05-14 06:51:25 +00:00
security-review-bot left a comment
Collaborator
Copy Link
Copy Source

Security Review

Summary

Trivial documentation update replacing --gitea-url with --vcs-url in the CLI example. No security implications and aligns with prior renaming work. CI passed.

Recommendation

APPROVE — Approve as is. The change correctly updates the CLI usage to reflect the new flag name and does not introduce any security risks. Consider scanning the rest of the README and related docs for any lingering references to --gitea-url to ensure complete consistency.

Review by security

Evaluated against d3bb83a1

# Security Review ## Summary Trivial documentation update replacing --gitea-url with --vcs-url in the CLI example. No security implications and aligns with prior renaming work. CI passed. ## Recommendation **APPROVE** — Approve as is. The change correctly updates the CLI usage to reflect the new flag name and does not introduce any security risks. Consider scanning the rest of the README and related docs for any lingering references to --gitea-url to ensure complete consistency. --- *Review by security* <!-- review-bot:security --> --- *Evaluated against d3bb83a1*
gpt-review-bot approved these changes 2026-05-14 06:51:33 +00:00
gpt-review-bot left a comment
First-time contributor
Copy Link
Copy Source

Gpt Review

Summary

The PR updates the README CLI example to use the new --vcs-url flag, aligning the documentation with prior code changes. The change is correct and consistent with the rest of the README.

Recommendation

APPROVE — This is a straightforward documentation fix replacing --gitea-url with --vcs-url in the CLI example. CI has passed and the change matches the established environment variable and flag mappings elsewhere in the README. Approve as-is.

Review by gpt

Evaluated against d3bb83a1

# Gpt Review ## Summary The PR updates the README CLI example to use the new --vcs-url flag, aligning the documentation with prior code changes. The change is correct and consistent with the rest of the README. ## Recommendation **APPROVE** — This is a straightforward documentation fix replacing --gitea-url with --vcs-url in the CLI example. CI has passed and the change matches the established environment variable and flag mappings elsewhere in the README. Approve as-is. --- *Review by gpt* <!-- review-bot:gpt --> --- *Evaluated against d3bb83a1*
rodin merged commit d3bb83a10a into main 2026-05-14 07:08:16 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
sonnet-review-bot
security-review-bot
gpt-review-bot
Labels
Clear labels
ai-review
bug
needs-review
ready
Ready for human review
 self-reviewed
Self-review passed since last push
 wip
Work in progress - do not start new work on this PR
No Label ready self-reviewed
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
security-review-bot rodin (Rodin)
No Assignees aweiker
4 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: rodin/review-bot#128
Delete Branch "fix/125-readme-cli-example"

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?