Repository navigation
docs(lavaflow): explain issue-to-merge delivery #238
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
565df51
39e2d3d
c9417cd
6b890d2
2d3ef4e
852fd80
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -185,11 +185,11 @@ that changes a path, use `--human-review-path`; see [Merge fixes](#merge-fixes). | |
|
|
||
| ### Merge fixes | ||
|
|
||
| At autonomy `merge`, LavaFlow can merge its fix pull requests. A fix built on | ||
| a commit the deploy reported, at either | ||
| [verification level](deploy.md#verification), is always held for a person. | ||
| Only a fix on a commit that a push to the repository deployed is free of that | ||
| hold. A fix it holds or stops is yours to review and merge on GitHub. | ||
| At autonomy `merge`, LavaFlow can merge fixes built on verified source, | ||
| including a frontend upload with [file verification](deploy.md#verification). | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟡 P2: Align the linked deploy guide with file-verified merge eligibility This now allows automatic merging for file-verified frontend uploads, but the linked Found by gpt-6.1-sol |
||
| For an upload with repository verification only, check the fix against the | ||
| deployed code and merge it yourself. LavaFlow gives those fixes the | ||
| `client_reported_commit` hold. | ||
|
|
||
| ```bash | ||
| volcano cloud lavaflow settings set --autonomy merge | ||
|
|
@@ -237,7 +237,10 @@ volcano cloud lavaflow settings set --human-review-path 'infra/**' --human-revie | |
| ``` | ||
|
|
||
| `show` prints `Merge:` in its `Fix:` block with where the merge is: | ||
| `waiting for CI`, `queued to merge`, `merged`, `held` or `stopped`. A merged | ||
| `waiting for CI`, `queued to merge`, `merged`, `held` or `stopped`. When | ||
| GitHub still requires an approval, the run's API status is | ||
| `merge.status: waiting_for_approval`. LavaFlow continues after approval. | ||
| A merged | ||
| fix says `merged by LavaFlow`, or `merged by someone else` when a person | ||
| merged it while LavaFlow waited. While merging is paused, a | ||
| waiting fix says `paused while merging is off` instead. `held` and | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,9 +6,10 @@ description: 'Connect an Aikido workspace so LavaFlow opens fix pull requests fo | |
| Connect your [Aikido](https://www.aikido.dev) workspace, bind a project, and | ||
| each new code (SAST) issue Aikido finds on the project's GitHub repository | ||
| starts a [LavaFlow](lavaflow.md) run. LavaFlow | ||
| reads the issue, diagnoses it, and opens a pull request with the fix for you | ||
| to review. It never merges an Aikido fix, and it writes nothing back to | ||
| Aikido: follow the run in Volcano. | ||
| reads the issue, diagnoses it, and opens a pull request when it can fix the | ||
| problem. With `autonomy: merge`, LavaFlow follows the PR through review, | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟡 P2: Reconcile the remaining manual-only delivery descriptions The introduction now promises merging under Found by gpt-6.1-sol |
||
| required checks, and merge. Follow the run in Volcano. LavaFlow writes | ||
| nothing back to Aikido. | ||
|
|
||
| Aikido reports need the project's `lavaflow.aikido` capability. They are | ||
| rolling out environment by environment, so check it first. It is available | ||
|
|
@@ -116,8 +117,9 @@ A new issue starts a run when all of these hold: | |
| - Its code repository is on GitHub, and is the bound project's repository. | ||
|
|
||
| LavaFlow reads the issue's title, rule, file and lines, and Aikido's advice | ||
| for fixing it, then runs its usual diagnosis, fix and review. The run stops at | ||
| a pull request, whatever the project's own autonomy. | ||
| for fixing it, then runs its usual diagnosis, fix, and review. The project's | ||
| autonomy determines whether LavaFlow follows the fix through merge or leaves | ||
| the merge to you. | ||
| If several bound projects share the repository, the first one bound that | ||
| LavaFlow can run on gets the issue. | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -106,14 +106,24 @@ report. A later mention in the thread starts a new report, which reads the | |
| thread again: for example, a request for a change after the run's result, or a | ||
| retry after LavaFlow refused the report at a limit. | ||
|
|
||
| LavaFlow then answers in the thread with the project it picked and a link to | ||
| its repository, and posts the outcome as a new reply. It never edits an | ||
| earlier reply, so the thread keeps each step of the report. A run from Slack goes as far as opening a fix | ||
| pull request, even where the project lets LavaFlow merge, and so does a run | ||
| someone starts again on the report's issue: merging a fix someone reported in | ||
| Slack stays a person's step. The outcome is the pull request's link, or a | ||
| fixed reason it opened none, and a link to the run in Volcano. The run link | ||
| opens the report's project in the same environment as the Slack app and still | ||
| LavaFlow replies with the project it picked and its repository. With | ||
| [`autonomy: merge`](lavaflow.md#merge-fixes), LavaFlow can take an issue from | ||
| Slack to a merge on the project's production branch. It pins the repository | ||
| revision and reviews the fix. Where review on a draft PR is available, it | ||
| revises that draft and marks it ready once review clears. It follows the required checks and approvals and merges the PR when | ||
| they pass. It uses the repository's merge queue when required. With | ||
| `autonomy: open_pr`, you review and merge the resulting PR. | ||
|
|
||
| The thread receives a link to the run in Volcano and a link to the PR when | ||
| one opens. LavaFlow replies when GitHub records the merge or LavaFlow needs | ||
| help. If no PR opens, the thread gives a reason. | ||
| LavaFlow follows an active report within its retention window, at most 10 days | ||
| from the report. If the report expires before the merge, or LavaFlow loses | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ⚪ P3: Data and retention still says a run waiting on a deleted report stops, while the new text says it holds the PR The new paragraph says that if the report expires before the merge, "the run holds the PR with Found by claude-opus-5-5 |
||
| access or can no longer verify the base, the run holds the PR with | ||
| `report_admission_lost`. Review and merge the open PR on GitHub if it is | ||
| still applicable. | ||
|
|
||
| The run link opens the report's project in the same environment as the Slack app and still | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ⚪ P3: "The run link" no longer has anything to refer to The old text said the outcome reply contains "the pull request's link, or a fixed reason it opened none, and a link to the run in Volcano". The rewrite keeps the next sentence, "The run link opens the report's project…", but drops the sentence that told readers the thread gets a run link at all. Add the run link back to the description of what LavaFlow posts, for example in the "LavaFlow links the PR while following it…" sentence. Found by claude-opus-5-5 |
||
| requires access to that project. It never holds the diagnosis: | ||
| everyone in the channel reads the answer, including people who can't see the | ||
| project's runs. Read the diagnosis in Volcano, and follow the run like any | ||
|
|
@@ -164,11 +174,14 @@ what you're asking for: | |
| run and asks you to say what to change in your own message. | ||
|
|
||
| LavaFlow builds what the request asks for and nothing beyond it, and its | ||
| reviewers hold anything else the change adds. The request can't change what | ||
| LavaFlow may do: its permissions, the files it may not change, its review, and | ||
| when it opens a pull request stay the same, and the run stops at a pull | ||
| request for a person to review and merge. The pull request says it proposes a | ||
| requested change, not a fix, and the run's `diagnosis.requested` is `true`. | ||
| reviewers hold anything else the change adds. Your project settings and | ||
| repository rules determine whether LavaFlow can merge. To stop after opening | ||
| the PR, write `@Volcano add hello.md containing "hello world". Open a PR and | ||
| leave the merge to me.` LavaFlow opens the PR and leaves the merge to you. To keep it | ||
| as a draft, say "leave the PR as a draft." Asking to open a draft PR still | ||
| lets LavaFlow mark it ready when reviews pass. | ||
| The pull request describes the requested change, and the run sets | ||
| `diagnosis.requested` to `true`. | ||
| When the request is unclear, the result already exists, or the change lies | ||
| outside the repository, LavaFlow opens nothing and says so in the thread. | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟡 P2: CLI deploy guide still says fixes on reported commits at either verification level are held
This PR changes the CLI LavaFlow page to say LavaFlow can merge fixes built on a frontend upload with file verification, and only
repository-verified uploads get theclient_reported_commithold. The platform guide's hold table now says the same. But the page this line links to,content/cli/deploy.md#verification(lines 345–349), still says: "At autonomymerge, LavaFlow holds a fix built on a reported commit, at either level, for a person to merge." Someone who deploys a frontend with the CLI and follows this link gets the opposite answer about whether LavaFlow will merge the fix without them. Update that paragraph indeploy.mdto say that onlyverification: repositoryfixes are held withclient_reported_commit.Found by claude-opus-5-5