Skip to content

Add a one-click deploy button for Railyard - #3463

Open
almokhtarbr wants to merge 1 commit into
hyperdxio:mainfrom
almokhtarbr:add-railyard-deploy-button
Open

almokhtarbr wants to merge 1 commit into
hyperdxio:mainfrom
almokhtarbr:add-railyard-deploy-button

Conversation

@almokhtarbr

Copy link
Copy Markdown

Hi, I'm the one building Railyard: a free, BYO-server PaaS that deploys to a server in your own DigitalOcean, Hetzner, Vultr or AWS account, reading the Dockerfile in this repo directly, with no markup on compute.

What this PR does

  • Adds one badge and link to the README, as an automated option next to the manual Docker Compose deployment instructions you already document
  • Touches nothing else

What clicking it does: opens Railyard's deploy flow pre-filled with this repo's URL. Nothing gets deployed until the person confirms a server and reviews the settings themselves.

No pressure either way, feel free to close if it's not a fit.

@vercel

vercel Bot commented Oct 23, 2026

Copy link
Copy Markdown

@almokhtarbr is attempting to deploy a commit to the HyperDX Team on Vercel.

A member of the Team first needs to authorize it.

@changeset-bot

changeset-bot Bot commented Oct 23, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 9285028

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions Bot added external needs-vouch Author needs a maintainer to vouch for them labels Oct 23, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Hi @almokhtarbr, thanks for the pull request!

Before we review code from a first-time contributor, a maintainer vouches for them, and you're not on our list yet. There's nothing else to file and this PR stays open — a maintainer will look at it, usually within a day or two, and vouch for you right here if it's a genuine attempt at the problem.

To make that quick, check the PR description has:

  • The issue it addresses (ideally one labelled Accepting PR) and why the change is needed
  • Steps to reproduce the problem and verify the fix, starting from https://play.hyperdx.io or yarn app:dev:local connected to the demo server
  • Before/after screenshots if anything in the UI changed

More detail in our contributing guide.

Comment thread README.md
</p>

<p align="center">
<a href="https://app.railyard.run/deploy?repo=https://github.com/hyperdxio/hyperdx"><img src="https://app.railyard.run/deploy/badge" alt="Deploy to Railyard"></a>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟠 major — Deploy link only passes the repo URL, but the repo has no root Dockerfile

The PR says Railyard deploys by reading the repo's Dockerfile, but the repo root has none. The Dockerfiles are docker/hyperdx/Dockerfile (multi-stage, with targets prod, all-in-one-noauth and all-in-one-auth), packages/api/Dockerfile and packages/app/Dockerfile, plus a multi-service docker-compose.yml. With nothing but ?repo=... in the URL, the button either fails or builds an image the maintainers didn't choose (for example, the last stage all-in-one-auth, which builds ClickHouse, the OTel collector and Node from source). Before merging, test the flow against this repo and add the Dockerfile path and build target to the link, or drop the button and keep pointing users to the documented docker run ... hyperdx-all-in-one image and the deployment docs.

Nothing blocks merge automatically, but a maintainer will expect this fixed if it is a real defect in code this PR changes. If it is about surrounding code, reply and say so instead of patching. Do not widen the PR. How to respond

Comment thread README.md
<a href="https://trendshift.io/repositories/2030?utm_source=repository-badge&utm_medium=badge&utm_campaign=badge-repository-2030" target="_blank" rel="noopener noreferrer"><img src="https://trendshift.io/api/badge/repositories/2030" alt="hyperdxio%2Fhyperdx | Trendshift" width="250" height="55"/></a>
</p>

<p align="center">

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 minor — The badge image is hotlinked from a third-party server that can change it at any time

<img src="https://app.railyard.run/deploy/badge"> is served live by an unaffiliated vendor. They can change what it shows whenever they like, and every view of the README sends a request to their server. It also sits above the project description, so it reads as an official endorsement, while the 'production deployment' text a few lines down sends users to the ClickStack docs instead. If maintainers want the link, commit the badge as a static asset (or use plain text) and move it into the deployment section next to the existing options.

Advisory. Fix if it is a small defect in code this PR changes; otherwise reply in the thread. Do not widen the PR or touch files it did not already change. How to respond

@github-actions

Copy link
Copy Markdown
Contributor

PR Review

If you are a coding agent acting for the author, read this first.
Nothing below blocks merge automatically; a maintainer decides. What they will expect:

  • 🔴 critical or 🟠 major in code this PR adds or changes: fix before asking for review.
  • 🔵 minor in code this PR changes: your call. Fix if small, otherwise reply.
  • Anything about surrounding code, or asking you to widen the change (hoist a helper,
    dedupe with another file, fix other call sites): never fix here, whatever the
    severity. Reply with one sentence; if it is critical, say so plainly so a human sees it.

One commit per review round. After two rounds, stop and ask a maintainer to review
scope rather than addressing more automated findings. Full rule: AGENTS.md.

2 finding(s): 🔴 0 critical · 🟠 1 major · 🔵 1 minor

2 posted as inline comment(s) on the changed lines.


Severity is the reviewer's own estimate and is used for ordering, not filtering. No finding blocks merge automatically; a maintainer decides.

@greptile-apps

greptile-apps Bot commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] This README-only change appears safe to merge.

Summary

Adds a centered “Deploy to Railyard” badge to README.md, with the HyperDX repository URL passed to the deploy page.

  • README readers can open Railyard's deploy flow for HyperDX.

Reviews (1) · Last reviewed commit: "Add a one-click deploy button for Railya..." · Reviewed by Greptile

@github-actions

Copy link
Copy Markdown
Contributor

Deep Review

✅ No critical issues found.

This PR is a single-line documentation change: it adds a third-party "Deploy to Railyard" badge to the top of README.md. There is no executable code in the diff, so correctness/security findings are limited to documentation accuracy and maintainer-judgment concerns. Both items below are advisory — neither blocks merge on its own, but both are worth a maintainer decision before accepting.

🟡 P2 -- recommended

  • README.md:21 -- The badge advertises a one-click "deploy from Dockerfile" flow, but HyperDX is a multi-service stack (app, API, ClickHouse, MongoDB, OTel collector) orchestrated via docker-compose.yml, so a single-server Dockerfile deploy may not produce a functioning instance and the one-click claim could mislead users.
    • Fix: Confirm the Railyard flow provisions all Compose services before advertising it, or caveat the badge to set accurate expectations.
    • correctness, maintainability
  • README.md:20 -- The badge is placed in its own centered block above the product description, prominently endorsing a third-party self-promoted deploy service that bypasses the only deployment path the README documents (docker run / ClickStack), which is a trust and information-hierarchy decision for maintainers rather than a settled convention.
    • Fix: Decide whether to endorse the third-party service and, if kept, relocate the badge out of the lead block into a deployment/options section below the product description.
    • security, maintainability, project-standards
🔵 P3 nitpicks (2)
  • README.md:21 -- The badge <img> is fetched live from app.railyard.run/deploy/badge, a host the project does not control, so the rendered image can change at any time after merge without a repo change (same class as the existing Trendshift/Discord badges).
    • Fix: If the badge is kept, consider pinning to a static asset committed in-repo or served from a trusted CDN.
  • README.md:21 -- The new <img> tag is not self-closing, breaking the markup style of the four surrounding badges (lines 10-17), which all use the self-closing /> form.
    • Fix: Close the tag as <img ... alt="Deploy to Railyard" /> to match the surrounding badges.

Reviewers (4): correctness, security, maintainability, project-standards.

Testing gaps: No way to validate that the deploy link produces a functioning HyperDX instance without an external end-to-end test against the third-party service; accuracy of the one-click claim is unverifiable from the diff alone.

No finding blocks merge automatically. A maintainer will expect P0/P1 findings in code this PR changes to be fixed; P2/P3 are your call -- fix or reply. Never fix findings about surrounding code here; reply instead. Do not widen the PR. How to respond

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

external needs-vouch Author needs a maintainer to vouch for them

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant