showcase/bin/README.md
bin/railwaySingle-file Ruby tooling for showcase Railway operations.
The Showcase platform lives on Railway across two environments (staging and
production). Day-to-day operations — promoting staging to production, pinning
services to immutable image digests, rolling a bad deploy back, auditing drift
between envs — used to require ad-hoc shell + GraphQL recipes. bin/railway
makes those operations first-class CLI subcommands with consistent flags,
exit codes, and production protection.
None. Requires system Ruby 3.x (stdlib only — no Bundler, no Gemfile).
showcase/bin/railway --help
The tool reads a Railway API token from (in order):
RAILWAY_TOKEN environment variable~/.railway/config.json (the token field, or user.token)It never invokes railway login, railway logout, or op. If neither source
yields a token, it exits with code 2 and a clear error.
For GHCR digest resolution (resolve-digest, pin), set GHCR_TOKEN if you
need to read private packages; public packages work anonymously via the GHCR
/token endpoint.
| Subcommand | Purpose |
|---|---|
snapshot | Capture an env's services + config into a YAML snapshot. |
restore | Restore an env to a snapshot (force-redeploy each service). |
rollback | Roll a single service back one deploy (or to a specific deployment id with --to). |
rollback-commit | Restore an env to the snapshot committed at a given git SHA. |
promote | Promote staging digests to production with prechecks. |
pin | Pin a service to a specific image digest. |
env-diff | Diff two envs; exits 1 on drift. |
resolve-digest | Resolve an image tag (e.g. :latest) to its sha256: digest. |
lint-prod | CI gate (advisory): warn if any prod service is not digest-pinned. --exit-zero for advisory mode, --format json for machine-readable output. |
Run any subcommand with --help for full flag list.
Every subcommand that mutates state requires both:
--yes flag, andproduction on stdin…before any production mutation runs. --non-interactive skips the prompt
but still requires --yes. There is no way to mutate production without an
explicit acknowledgement.
| Code | Meaning |
|---|---|
| 0 | Clean / success |
| 1 | Drift detected, findings reported, or promote refused for policy reasons |
| 2 | Error (auth, network, GraphQL schema, refused confirmation, etc.) |
# 1. Audit drift first (read-only).
showcase/bin/railway env-diff staging production
# DRIFT: 3 finding(s)
# service showcase-shell: digest sha256:abc != sha256:def
# ...
# 2. Lint prod to confirm baseline is pinned.
showcase/bin/railway lint-prod
# OK: all production services digest-pinned.
# 3. Capture a "before" snapshot in case we need to roll back.
showcase/bin/railway snapshot --env production --output before-promote.yaml
# 4. Run the promote with prechecks. Production confirmation prompt fires here.
showcase/bin/railway promote --yes
# Type 'production' to confirm promote: production
# promoted showcase-shell -> ghcr.io/copilotkit/showcase-shell@sha256:def...
# ...
# If anything goes sideways:
showcase/bin/railway restore --env production --snapshot before-promote.yaml --yes
.github/workflows/showcase_lint_prod.yml runs bin/railway lint-prod on
every PR that touches showcase/**.
Currently advisory — the workflow passes --exit-zero, so findings print
to the job log but do not fail the PR. This lets us soak the check against
real production state before turning it into a hard gate. Once we've built
confidence the findings are clean, remove --exit-zero from the workflow to
flip the check to enforcing (exit 1 on drift).
Long-term contract: every production service must be pinned to an immutable
ghcr.io/...@sha256:... digest, and the lint job will fail any PR that
drifts away from that.
Two human-facing surfaces render the audit result every run:
$GITHUB_STEP_SUMMARY so the audit shows at the top of every
run page (every event: pull_request, push, workflow_dispatch).pull_request events, the workflow posts (or
updates) a single comment per PR. The comment is keyed by the HTML marker
<!-- lint-prod-sticky-comment --> so re-runs update the same comment
instead of creating duplicates.Both surfaces show the same content: a one-line status, a table of the
unpinned services (only — pinned services are not enumerated), and a
Pacific-time run timestamp with the finding count.
lint-prod --format json emits:
{
"services": [
{ "name": "...", "source": "...", "status": "pinned|mutable-tag" }
],
"findings": 3,
"timestamp": "2026-05-27T18:00:00Z"
}
The CI workflow uses this shape to render the step summary and PR comment.
The findings count is also written to $GITHUB_OUTPUT so downstream jobs
(e.g. a future Slack alert step) can compare against prior runs.
ruby showcase/bin/spec/all_tests.rb
Tests are minitest (stdlib). They cover:
No Railway / GHCR network calls are made during tests.