Repository navigation
chore: make the runner and backend docs match the code, and reject bot configs that panic - #339
Merged
Merged
Conversation
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.
A static audit of the repo turned up a handful of places where the docs describe behaviour the code no longer has, one leftover compatibility input, and bot settings that are accepted and then panic. This fixes the ones that still hold on current
main.Docs that disagreed with the code
chunk-jvmREADME: the JVM also gets-Xmsand--enable-native-access, runs the serial collector on one CPU, and records an AOT cache from 448 MiB on one CPU rather than 768 MiB.chunk-backendREADME: schema changes were described as additive only, with field and index changes rejected. They are accepted when the deployment's migration journal carries a migration for them.chunk-store: theOperationcomment said the fingerprint hashes the deployment and contract. It hashes the function, caller and arguments, so a result survives redeployment.chunk-management:fork_environmentsaid it deploys the source's active release. A fork starts without a deployment and gets the release its restored data was serving.Behaviour
CHUNK_SERVICESno longer acceptsexec. It was ignored with a warning; it is now an unknown service like any other.chunk-botsrejects settings that previously passed validation and panicked later:--first/--botscombinations that overflow au32, intervals and timeouts that are not finite or exceed a day, login rates below 0.001, and thread or pending counts of zero or beyond what Tokio accepts.Checks
cargo fmt --checkandcargo clippy --all-targets -D warningson the touched crates, thechunk-environmentservices test, and each rejected bot setting by hand. Three review rounds, the last clean.🤖 Generated with Claude Code