Skip to content

Document what a configuration change requires - #46

Open
devin-ai-integration[bot] wants to merge 3 commits into
mainfrom
devin/1786379042-config-change-phases-docs
Open

Document what a configuration change requires#46
devin-ai-integration[bot] wants to merge 3 commits into
mainfrom
devin/1786379042-config-change-phases-docs

Conversation

@devin-ai-integration

@devin-ai-integration devin-ai-integration Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Summary

New config-as-code/configuration-changes page 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 REQUIRES column and confirmation prompt in ravion project config apply, with --yes to skip it in scripts). Examples are real standard-library inputs, including the two non-obvious cases: rvn-ec2-service environment_variables/secrets need a stack update and a deploy (the deploy re-renders the env file on running instances), and rvn-aws-static build_environment_variables need a rebuild and a deploy (the deploy promotes the versioned directory).

The per-input applies_on field 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 validate and mint broken-links (the repo's own pnpm validate can't launch in a fresh clone — ERROR packages field missing or empty from 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.

  • Explains stack update, rebuild, and deploy as separate phases.
  • Documents Dashboard and CLI reporting and confirmation behavior.
  • Provides standard-library examples and fallback guidance for older module definitions.

Confidence Score: 4/5

The PR appears safe to merge, with a non-blocking documentation gap around the linked applies_on schema 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

Filename Overview
config-as-code/configuration-changes.mdx Adds the lifecycle guide; its schema-reference link currently leads to generated documentation that does not define the introduced applies_on field.
docs.json Correctly registers the new page in the Config as code navigation group.

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 --> F
Loading
Prompt To Fix All With AI
### Issue 1
config-as-code/configuration-changes.mdx:41-42
**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.

Reviews (1): Last reviewed commit: "Document configuration change phases" | Re-trigger Greptile

Greptile also left 1 inline comment on this PR.

Co-Authored-By: brandon <brandon@flightcontrol.dev>
@flybayer flybayer self-assigned this Aug 10, 2026
@mintlify

mintlify Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Ravion 🟢 Ready View Preview Aug 10, 2026, 4:27 PM

@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

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).

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 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>
| 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. |

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

should be build not rebuild

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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>
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