Document what a configuration change requires - #46
Open
devin-ai-integration[bot] wants to merge 3 commits into
Open
Document what a configuration change requires#46devin-ai-integration[bot] wants to merge 3 commits into
devin-ai-integration[bot] wants to merge 3 commits into
Conversation
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Comment on lines
+41
to
+42
| The per-input `applies_on` field records this lifecycle metadata in a module | ||
| definition. See the [module definition schema reference](/module-definitions/definition-schema/inputs). |
There was a problem hiding this comment.
Linked schema omits
applies_on
This page directs module authors to the input schema reference for applies_on, but that generated reference does not define the field or its accepted values, leaving authors unable to use the documented lifecycle metadata.
Prompt To Fix With AI
This is a comment left during a code review.
Path: config-as-code/configuration-changes.mdx
Line: 41-42
Comment:
**Linked schema omits `applies_on`**
This page directs module authors to the input schema reference for `applies_on`, but that generated reference does not define the field or its accepted values, leaving authors unable to use the documented lifecycle metadata.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.Co-Authored-By: brandon <brandon@flightcontrol.dev>
flybayer
reviewed
Aug 11, 2026
| | Phase | What it does | | ||
| | --- | --- | | ||
| | **Stack update** | Runs the module's stack pipeline to create or update infrastructure. | | ||
| | **Rebuild** | Creates a new application image or other build artifact. | |
Contributor
Author
There was a problem hiding this comment.
Fixed in e505467 — "build" everywhere now. Also swapped the page's "phase" vocabulary for "action" to match the rename landing in the API/CLI.
Co-Authored-By: brandon <brandon@flightcontrol.dev>
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
New
config-as-code/configuration-changespage answering the question the new apply-phase metadata exists for: I changed a module input — what now?Explains that a stack update, a rebuild and a deploy are separate things, that saving configuration doesn't necessarily run all of the phases a change requires, and where each surface reports the requirement (the save confirmation dialog in the dashboard; the
REQUIREScolumn and confirmation prompt inravion project config apply, with--yesto skip it in scripts). Examples are real standard-library inputs, including the two non-obvious cases:rvn-ec2-serviceenvironment_variables/secretsneed a stack update and a deploy (the deploy re-renders the env file on running instances), andrvn-aws-staticbuild_environment_variablesneed a rebuild and a deploy (the deploy promotes the versioned directory).The per-input
applies_onfield isn't re-documented here — it's generated into the definition schema reference from the schema source, so the page links there.Depends on flightcontrol#6883 for the dialog and CLI behavior described.
Validated with
npx mint@latest validateandmint broken-links(the repo's ownpnpm validatecan't launch in a fresh clone —ERROR packages field missing or emptyfrom pnpm before Mintlify starts, unrelated to this change).Link to Devin session: https://app.devin.ai/sessions/a32da8ecb942427eb0e38330c7ff8294
Requested by: @flybayer
Greptile Summary
Adds a configuration-change lifecycle guide and registers it under the Config as code documentation navigation.
Confidence Score: 4/5
The PR appears safe to merge, with a non-blocking documentation gap around the linked
applies_onschema reference.The page and navigation are structurally valid, but readers cannot use the linked schema reference to learn the documented lifecycle field because that generated reference does not yet contain it.
Files Needing Attention: config-as-code/configuration-changes.mdx
Important Files Changed
applies_onfield.Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart LR A[Change module input] --> B[Save or apply configuration] B --> C{Required phases} C --> D[Stack update] C --> E[Rebuild] C --> F[Deploy] D --> F E --> FPrompt To Fix All With AI
Reviews (1): Last reviewed commit: "Document configuration change phases" | Re-trigger Greptile