Files
Jordan Ritter 914dbc5855 fix(showcase/bin): surface GHCR /token exchange failures instead of masking them
bearer_for ended with a blanket `rescue StandardError => nil` plus
`return nil if status >= 400`. Now that bearer_for ALWAYS performs the
/token exchange (even when a token is present), that swallow masked real
failures: a non-2xx /token response, a malformed JSON body, or a transport
error all collapsed to nil, after which manifest_exists issued the manifest
HEAD anonymously (no Authorization). That silently violated manifest_exists's
documented raise-on-transport/5xx contract and conflated "no token supplied"
with "supplied token failed to exchange".

bearer_for now:
- raises GHCR::Error on a >=400 /token response WHEN a token was supplied
  (token absent still returns nil — the legitimate anonymous-public fallback);
- raises GHCR::Error on JSON::ParserError for an unparseable 200 body;
- no longer swallows StandardError, so transport exceptions
  (Errno::ECONNREFUSED, Net::ReadTimeout, ...) propagate.

Call-site enumeration (bearer_for is called only by manifest_exists and
resolve_digest):
- manifest_exists: documents "Raises GHCR::Error on 5xx or transport failure",
  so a raised exchange error is consistent with — and strengthens — its own
  contract. Assumption holds.
- resolve_digest: already raises GHCR::Error on its own manifest HEAD >=400 and
  does not rescue bearer_for, so a raised exchange error propagates exactly as
  its other failures do. Assumption holds.
Neither caller is broken by bearer_for raising; both already propagate
GHCR::Error to their callers.

Tests: add 3 red-green cases in test_ghcr_bearer.rb (token-present 401 raises;
token-present malformed body raises; token-present exchange failure issues NO
anonymous manifest HEAD). The existing manifest_exists/digest fakes were only
green because the old swallow masked the fake's "no fake response" error — they
never modeled the mandatory /token exchange; added a successful /token fake to
each so they exercise the real path. Renumbered the snapshot-ivar-lint
allowlist (+13 lines) to track the bin/railway line drift.
2026-06-04 09:18:08 -07:00
..
2026-05-28 17:52:35 +00:00

bin/railway

Single-file Ruby tooling for showcase Railway operations.

Why

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.

Install

None. Requires system Ruby 3.x (stdlib only — no Bundler, no Gemfile).

showcase/bin/railway --help

Auth

The tool reads a Railway API token from (in order):

  1. RAILWAY_TOKEN environment variable
  2. ~/.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.

Subcommands

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.

Production protection

Every subcommand that mutates state requires both:

  • --yes flag, and
  • typed confirmation of the literal string production 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.

Exit codes

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.)

Worked example: promote staging → production

# 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

CI integration

.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.

Visibility surfaces

Two human-facing surfaces render the audit result every run:

  1. Workflow step summary — the workflow writes a structured markdown block to $GITHUB_STEP_SUMMARY so the audit shows at the top of every run page (every event: pull_request, push, workflow_dispatch).
  2. Sticky PR comment — on 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.

Machine-readable output

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.

Tests

ruby showcase/bin/spec/all_tests.rb

Tests are minitest (stdlib). They cover:

  • argv parsing per subcommand
  • snapshot YAML round-trip
  • GHCR digest-resolution decision tree (mocked HTTP)
  • production-protection prompt behavior

No Railway / GHCR network calls are made during tests.