Skip to content

fix: update railway docs to include graceful shutdown#4715

Open
MasterPtato wants to merge 1 commit into04-23-fix_add_wf_registry_commandfrom
04-23-fix_update_railway_docs_to_include_graceful_shutdown
Open

fix: update railway docs to include graceful shutdown#4715
MasterPtato wants to merge 1 commit into04-23-fix_add_wf_registry_commandfrom
04-23-fix_update_railway_docs_to_include_graceful_shutdown

Conversation

@MasterPtato
Copy link
Copy Markdown
Contributor

Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@MasterPtato MasterPtato mentioned this pull request Apr 23, 2026
11 tasks
@claude
Copy link
Copy Markdown

claude Bot commented Apr 23, 2026

PR Review: fix: update railway docs to include graceful shutdown

This PR adds a "Graceful Shutdown" section to the Railway self-hosting docs. The intent is correct and valuable, but there are a few issues to address before merging.


Critical: Wrong recommended grace period

The new section recommends 60 seconds as a grace period. Every other doc in the repo specifies 130 seconds:

  • actors/versions.mdx: "Ensure your platform's shutdown grace period is at least 130 seconds"
  • general/production-checklist.mdx: "Set a graceful shutdown period of at least 130 seconds."
  • self-hosting/kubernetes.mdx: terminationGracePeriodSeconds: 130

The 130-second floor exists because the runner waits up to 120 seconds for actors to drain (plus a ~10-second buffer). A 60-second drain window will silently truncate actor draining on every deploy, defeating the purpose of this feature.

Fix: Update all three drainingSeconds examples (dashboard UI, config-as-code, env var) to use 130 instead of 60.


CLAUDE.md violation: Em dashes

CLAUDE.md explicitly states: "Do not use em dashes (—). Use periods to separate sentences instead."

Two em dashes appear in the new content:

  • **Draining seconds** — the grace window...
  • ...the wrapper becomes PID 1 and swallows the signal — your app never drains...

These need to be rewritten using periods or restructured sentences.


Clarity: PID 1 guidance should specify which service it targets

A Railway project from this guide has two services: the Rivet Engine (Step 2, rivetdev/engine:latest) and the user's application (Step 3). The PID 1 / signal-forwarding warning applies specifically to the user's application container, not to the Rivet Engine image. The section doesn't make this distinction, so readers may either modify the Rivet Engine image unnecessarily or skip the fix for their own app.


Minor: Section placement

The forward-reference at Step 2 points to a "Graceful Shutdown" section that appears after Step 3. Readers following numbered steps will be directed to a section they haven't reached yet. Consider moving the shutdown section before Step 3 or embedding it as a sub-step under Step 2.


What looks correct

  • Frontmatter fields (title, description, skill) are all present and valid.
  • No rivet.gg usage; Railway links correctly use railway.com.
  • Documenting all three configuration methods (dashboard, config-as-code, env var) is a nice touch.
  • Conventional commit format is followed.

@MasterPtato MasterPtato force-pushed the 04-23-fix_add_wf_registry_command branch from dfd9202 to b4e1f50 Compare April 24, 2026 18:20
@MasterPtato MasterPtato force-pushed the 04-23-fix_update_railway_docs_to_include_graceful_shutdown branch 2 times, most recently from db7f54d to df97819 Compare April 24, 2026 23:02
@MasterPtato MasterPtato force-pushed the 04-23-fix_add_wf_registry_command branch from b4e1f50 to 39b3555 Compare April 24, 2026 23:02
@MasterPtato MasterPtato force-pushed the 04-23-fix_add_wf_registry_command branch from 39b3555 to 2daf067 Compare April 25, 2026 01:07
@MasterPtato MasterPtato force-pushed the 04-23-fix_update_railway_docs_to_include_graceful_shutdown branch from df97819 to 3ff43a4 Compare April 25, 2026 01:07
@MasterPtato MasterPtato force-pushed the 04-23-fix_add_wf_registry_command branch from 2daf067 to f8853a2 Compare April 25, 2026 01:14
@MasterPtato MasterPtato force-pushed the 04-23-fix_update_railway_docs_to_include_graceful_shutdown branch from 3ff43a4 to 0a19554 Compare April 25, 2026 01:14
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