docs: Railpack provider values in schema enum#558
Merged
Conversation
The config schema did not enumerate provider values, and the configuration docs only described the field generically. Add explicit provider enum values to the generated schema, document the same values in the config file guide, and make provider lookup case-insensitive so lowercase documented values work for providers whose internal names are capitalized. Constraint: Central Station bounty asks for provider names to be discoverable in docs and JSON schema Rejected: Docs-only update | would leave railpack schema incomplete Confidence: high Scope-risk: narrow Directive: Keep provider docs and schema enum aligned with core/providers/provider.go Tested: go test ./core/config ./core/providers; bun run build in docs; go run ./cmd/cli schema shows provider enum; git diff --check Not-tested: go test ./... fails on existing environment/snapshot drift: Caddy/FrankenPHP patch snapshots and missing BUILDKIT_HOST for integration tests
5abae10 to
7aca227
Compare
Collaborator
|
Great improvement! Thanks. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
railpack schemaoutputprovidervalues in the config file guideelixiranddotnetThis also clarifies that
uvsupport is handled by thepythonprovider, not a separate provider.Related Central Station question: https://station.railway.com/questions/what-are-the-available-providers-in-rail-bae3a690
Verification
git diff --checkgo test ./core/config ./core/providersgo run ./cmd/cli schemashows the provider enumbun run buildindocsI also tried
go test ./...; it did not complete cleanly in this environment because existing example snapshots resolve newer Caddy/FrankenPHP patch versions and integration tests requireBUILDKIT_HOST. Those failures appear unrelated to this change.