Skip to content

[codex] Clarify review app deploy command copy#733

Merged
justin808 merged 1 commit intomasterfrom
codex/tiny-ux-command-test
May 9, 2026
Merged

[codex] Clarify review app deploy command copy#733
justin808 merged 1 commit intomasterfrom
codex/tiny-ux-command-test

Conversation

@justin808
Copy link
Copy Markdown
Member

@justin808 justin808 commented May 9, 2026

Summary

  • Clarifies that /deploy-review-app builds and deploys the PR branch.

Validation

  • bin/conductor-exec git diff --check
  • Local DB-backed system spec was blocked because Postgres was not running on /tmp/.s.PGSQL.5432; GitHub CI will run the full suite.

Note

Low Risk
Low risk: a single landing-page text change with no behavioral, data, or security impact.

Overview
Updates the homepage “Quick Review App Commands” copy to clarify that /deploy-review-app both builds and deploys the PR branch for testing (previously stated only deploy).

Reviewed by Cursor Bugbot for commit 4bcd0e1. Bugbot is set up for automated code reviews on this repo. Configure here.

Summary by CodeRabbit

  • Documentation
    • Updated help text for the deploy review app feature to clarify that it builds and deploys your PR branch for testing.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 9, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a29995fb-3037-4183-b49d-f347df09d19d

📥 Commits

Reviewing files that changed from the base of the PR and between b75a6ac and 4bcd0e1.

📒 Files selected for processing (1)
  • app/views/pages/index.html.erb

Walkthrough

Help text for the /deploy-review-app command is clarified to specify that the process builds and deploys the PR branch for testing.

Changes

Help Text Update

Layer / File(s) Summary
Help Text Update
app/views/pages/index.html.erb
Help text for the /deploy-review-app command changes from "Deploy your PR branch for testing" to "Build and deploy your PR branch for testing."

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A rabbit hops through the deploy,
Adding "Build" to the joy,
Clarity blooms in a word,
The finest prose ever heard,
Testing branches, clear as can be! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: clarifying the copy for the review app deploy command from 'Deploy' to 'Build and deploy'.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/tiny-ux-command-test

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@justin808
Copy link
Copy Markdown
Member Author

/help

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented May 9, 2026

Greptile Summary

This PR updates the UI copy in app/views/pages/index.html.erb to clarify the behavior of the /deploy-review-app slash command.

  • The description for /deploy-review-app is updated from "Deploy your PR branch for testing." to "Build and deploy your PR branch for testing." to accurately reflect that the command both builds and deploys the branch.

Confidence Score: 5/5

Safe to merge — the change is a one-word copy clarification with no logic, routing, or data implications.

The only change is adding "Build and" to a UI description string. There are no functional, behavioral, or structural changes to review.

No files require special attention.

Important Files Changed

Filename Overview
app/views/pages/index.html.erb Single copy change: adds "Build and" to the /deploy-review-app description to clarify that the command also builds (not just deploys) the PR branch.

Sequence Diagram

sequenceDiagram
    participant User
    participant UI as index.html.erb
    participant CI as Review App CI

    User->>UI: Views /deploy-review-app description
    Note over UI: "Build and deploy your PR branch for testing."
    User->>CI: Issues /deploy-review-app command
    CI-->>CI: Build PR branch
    CI-->>CI: Deploy PR branch
    CI-->>User: Review app ready
Loading

Reviews (1): Last reviewed commit: "Clarify review app deploy command copy" | Re-trigger Greptile

@justin808
Copy link
Copy Markdown
Member Author

/deploy-review-app

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 9, 2026

Control Plane review app commands

/deploy-review-app
Create the review app or redeploy the PR branch to it.

/delete-review-app
Delete the review app and its temporary resources.

/help
Show the required GitHub variables, secrets, and workflow behavior.

@claude
Copy link
Copy Markdown

claude Bot commented May 9, 2026

Code Review

Overview

This PR updates a single line of UI copy in app/views/pages/index.html.erb, adding "Build and" before "deploy your PR branch for testing" to better describe what /deploy-review-app actually does.

Assessment

Code Quality / Style - The change is minimal and targeted: exactly one phrase added to a static <p> tag. Surrounding HTML structure and Tailwind classes are untouched.

Correctness - Accurately reflects the two-phase nature of the command (build + deploy). The previous copy was misleading because the command also triggers a build step before deploying.

Security - No user-supplied input, no dynamic data, no new ERB expressions. Purely static text.

Performance - No behavioral or rendering impact.

Tests / Validation - This is a static copy change with no logic to unit-test. CI will catch any template-syntax regressions.

Suggestions

None required. The change is self-contained, accurate, and reduces potential confusion for first-time visitors to the homepage.

Verdict: Ready to merge.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 9, 2026

Control Plane GitHub Flow

PR commands

/deploy-review-app

  • Creates the review app if it does not exist
  • Builds the PR commit image
  • Deploys the image and comments with the review URL
  • Comment body must be exactly /deploy-review-app — no surrounding text, trailing whitespace, or trailing newline. The trigger uses an exact-equality match, so a comment like please /deploy-review-app now or /deploy-review-app (with a trailing space) silently no-ops.

/delete-review-app

  • Deletes the review app when the PR is done
  • This also runs automatically when the PR closes
  • Same exact-match rule as /deploy-review-app: the comment body must be exactly /delete-review-app.

Repository secrets

Name Required Notes
CPLN_TOKEN_STAGING yes Service-account token scoped to the staging org.
CPLN_TOKEN_PRODUCTION yes (for promote) Service-account token scoped to the production org.
DOCKER_BUILD_SSH_KEY optional Private SSH key used when Docker builds fetch private deps via RUN --mount=type=ssh.

Repository variables

Name Required Notes
CPLN_ORG_STAGING yes Control Plane org for staging and review apps.
CPLN_ORG_PRODUCTION yes (for promote) Control Plane org for production.
STAGING_APP_NAME yes App name in controlplane.yml used as the staging deploy target.
PRODUCTION_APP_NAME yes (for promote) App name in controlplane.yml used as the production deploy target.
REVIEW_APP_PREFIX yes Prefix for per-PR review app names (e.g. review-app).
STAGING_APP_BRANCH optional Custom staging branch. Custom branches must also appear in cpflow-deploy-staging.yml's push filter.
PRIMARY_WORKLOAD optional Workload polled for health and rollback (defaults to rails).
DOCKER_BUILD_EXTRA_ARGS optional Newline-delimited extra docker build tokens (e.g. --build-arg=FOO=bar).
DOCKER_BUILD_SSH_KNOWN_HOSTS optional SSH known_hosts entries when SSH build hosts are not GitHub.com.
HEALTH_CHECK_ACCEPTED_STATUSES optional Space-separated HTTP statuses considered healthy on promote (default 200 301 302).
HEALTH_CHECK_RETRIES / HEALTH_CHECK_INTERVAL optional Production health polling controls; defaults to 24 retries and 15 seconds.
ROLLBACK_READINESS_RETRIES / ROLLBACK_READINESS_INTERVAL optional Post-rollback health polling controls; defaults to 24 retries and 15 seconds.
CPLN_CLI_VERSION optional Pin a specific @controlplane/cli version; falls back to the action default when unset.
CPFLOW_VERSION optional Pin a specific cpflow gem version; falls back to the generated default when unset.

Workflow behavior

  • Review apps are opt-in and created with /deploy-review-app
  • New commits redeploy existing review apps automatically
  • Slash command workflows run from the default branch until merged. Test PR-branch edits with gh workflow run cpflow-deploy-review-app.yml --ref <branch> -f pr_number=<pr-number>.
  • Pushes to the staging branch deploy staging automatically
  • Promotion to production is manual via the Actions tab
  • A nightly workflow removes stale review apps

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 9, 2026

@github-actions github-actions Bot temporarily deployed to review/qa-react-webpack-rails-tutorial-733 May 9, 2026 09:56 Inactive
@justin808
Copy link
Copy Markdown
Member Author

/delete-review-app

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 9, 2026

✅ Review app for PR #733 is deleted

Open organization console
View workflow logs

@justin808 justin808 merged commit 5c94c36 into master May 9, 2026
10 checks passed
@justin808 justin808 deleted the codex/tiny-ux-command-test branch May 9, 2026 22:03
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 9, 2026

✅ Review app for PR #733 is deleted

Open organization console
View workflow logs

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.

1 participant