Skip to content

docs(ravion): document --description on project config apply - #18

Merged
flybayer merged 8 commits into
mainfrom
devin/1785514742-apply-run-description-docs
Aug 2, 2026
Merged

docs(ravion): document --description on project config apply#18
flybayer merged 8 commits into
mainfrom
devin/1785514742-apply-run-description-docs

Conversation

@devin-ai-integration

@devin-ai-integration devin-ai-integration Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents ravion project config apply --description (flightcontrolhq/flightcontrol#6743, merged), which sets the description on every stack run an apply creates so runs link back to the change that caused them.

The CI-integration template's apply job derives that link in the same markdown Ravion writes for webhook-triggered pipeline runs, only trusting subjects GitHub authored as a merge or squash commit (any other #123 is an issue reference):

[[ $subject =~ ^Merge\ pull\ request\ \#([0-9]+)\ from\  ]] || [[ $subject =~ ^(.*)\ \(\#([0-9]+)\)$ ]]
# PR:     [PR #42 - Add dark mode support](.../pull/42) ([abcdef1](.../commit/abcdef123456))
# commit: [Fix login bug (abcdef1)](.../commit/abcdef123456)

The template also gains a monthly update-cli job that opens a PR bumping the CLI when a newer release exists. That moves the version out of env.RAVION_CLI_VERSION into a new .github/ravion-cli-version file, because GitHub refuses to let the Actions token push changes to files under .github/workflows/ — otherwise the job would need a PAT.

Also: regenerated cli/reference/project.mdx, a mention of the flag in config-as-code/project-config-file.mdx, and Vale vocabulary entries (config, repo, Flightcontrol, declaratively) that were failing spellcheck on the touched files.

Link to Devin session: https://app.devin.ai/sessions/1394b1c0836f44fc8ef4ac685d431726
Requested by: @flybayer

Co-Authored-By: brandon <brandon@flightcontrol.dev>
@devin-ai-integration
devin-ai-integration Bot requested a review from flybayer as a code owner July 31, 2026 16:19
@flybayer flybayer self-assigned this Jul 31, 2026
@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

@mintlify

mintlify Bot commented Jul 31, 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 Jul 31, 2026, 4:22 PM

…abulary

Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
@flybayer
flybayer merged commit b828deb into main Aug 2, 2026
4 checks passed
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