Skip to content

docs(ci): an evicted migration ends the run cancelled, not green - #1545

Merged
cristim merged 1 commit into
mainfrom
docs/migration-eviction-comment
Oct 27, 2026
Merged

cristim merged 1 commit into
mainfrom
docs/migration-eviction-comment

Conversation

@cristim

@cristim cristim commented Oct 27, 2026 •

Copy link
Copy Markdown
Member

Closes #201.

Problem: the migrate-aws concurrency comment in .github/workflows/database-migration.yml (~269-272) says an evicted queued migration "leaves the run green". That's false. Eviction cancels the queued job, and a run containing a cancelled job concludes cancelled, not success. #201 has the evidence: across about 700 runs, a cancelled job never coexisted with a success run conclusion.

Change (comment only): the clause now says the evicted job ends cancelled, so the run concludes cancelled, and that the summary job (if: always(), needing all three migrate jobs) still runs and prints the per-cloud results. The eviction fact and the other bullet are unchanged.

The issue's longer replacement text, a rewrite of the whole ~40-line block, isn't applied here. The block's other statements are still accurate, so this PR fixes only the false clause.

Local: actionlint passes on the file and pre-commit passes. No workflow logic changes.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Clarified that an AWS migration run evicted while queued ends as cancelled, rather than appearing successful.
    • Documented that the summary job still runs and reports results for each cloud.

The migrate-aws concurrency comment said an evicted queued migration leaves
the run green. A cancelled job makes the run conclude cancelled; the summary
job still runs and prints the per-cloud results. Closes #201

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@cristim cristim added impact/internal Team-internal only triaged Item has been triaged priority/p3 Polish / idea / may never ship severity/low Minor harm urgency/eventually No deadline effort/s Hours type/docs Documentation labels Oct 27, 2026
@coderabbitai

coderabbitai Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 5d86714 and 135a497.

Files selected for processing: 1
  • .github/workflows/database-migration.yml

Included review availability: This review used your included allowance. 1 included review remains after this review. Your included PR review attempts over the past 7 days set your current allowance at 2 reviews per hour.

Walkthrough

The workflow comment now states that evicting a queued migration leaves the run cancelled. It also notes that the always() summary job still prints per-cloud results.

Changes: Migration concurrency documentation

Layer / File(s) Summary
Clarify migration run outcome
.github/workflows/database-migration.yml
The comment replaces the claim that an evicted queued migration leaves the run green. It states that the run is cancelled and that the summary job still prints per-cloud results.

Priority: Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other · Severity of issue fixed: Low

Suggested reviewers: iamjsd

Merge Risk: Minimal · up to 135a4

This documentation-only correction is ready to merge.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title states the main change: a documentation fix in the CI workflow saying an evicted migration ends the run as cancelled rather than green. The changeset is a comment-only edit to .github/workfl…
Linked Issues check Passed Issue #201 requires a comment-only correction to the false claim that an evicted queued migration leaves the run green. The diff changes only the concurrency comment in `.github/workflows/database-mig…
Out of Scope Changes check Passed The whole-PR diff contains only three changed comment lines in .github/workflows/database-migration.yml. The diff does not change job declarations, expressions, concurrency groups, or workflow steps…
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within survi…
Full details: Title check

Explanation

The title states the main change: a documentation fix in the CI workflow saying an evicted migration ends the run as cancelled rather than green. The changeset is a comment-only edit to .github/workflows/database-migration.yml that corrects this claim, and the title's wording matches the linked issue #201 objective. The title is specific and accurate, though the 'docs(ci)' prefix and 64-character length are slightly longer than ideal.

Full details: Linked Issues check

Explanation

Issue #201 requires a comment-only correction to the false claim that an evicted queued migration leaves the run green. The diff changes only the concurrency comment in .github/workflows/database-migration.yml. It states that the evicted job ends cancelled, the run concludes cancelled, and the summary job still runs and prints per-cloud results. The concurrency declaration and workflow logic remain unchanged. No coding test requirement applies to this comment-only change.

Full details: Out of Scope Changes check

Explanation

The whole-PR diff contains only three changed comment lines in .github/workflows/database-migration.yml. The diff does not change job declarations, expressions, concurrency groups, or workflow steps. The comment correction and its clarification of summary behavior directly support issue #201. No unrelated change is present.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@cristim

cristim commented Oct 27, 2026

Copy link
Copy Markdown
Member Author

Independent review 2 (claude-fleet, cold): APPROVE 135a497

Scope: comment-only, .github/workflows/database-migration.yml (+3/-3), the concurrency note on migrate-aws (:264-274). No YAML keys change.

Findings: none blocking.

Checked:

  • The old comment was wrong for the reason the new one gives. An evicted pending migrate job is cancelled, not skipped or succeeded, so the run cannot be green. The summary job does not need to exit 1 for that.
  • summary (:638-644) declares needs: [validate, migrate-aws, migrate-gcp, migrate-azure] and if: always(), so it runs after a cancelled needs job and prints RESULT_AWS, RESULT_GCP and RESULT_AZURE from needs.<job>.result (:652 onward). That matches "still runs and prints the per-cloud results".
  • The same eviction applies to migrate-gcp (:430-432) and migrate-azure (:541-543), which point back to this note ("reasoning documented on migrate-aws"), so one corrected comment covers all three.
  • The rest of the note (cancel-in-progress false, the environment-approval caveat) is unchanged and still accurate.

Reviewed by an independent agent with no author context (second reviewer). Review only: nothing was pushed, and the GitHub review state is unchanged.

@cristim

cristim commented Oct 27, 2026

Copy link
Copy Markdown
Member Author

VERDICT: APPROVE 135a497
Findings: no actionable findings.

@cristim

cristim commented Oct 27, 2026

Copy link
Copy Markdown
Member Author

Local verification at 135a497d27d794030ef9a8fadef9f8dbe62116b1 merged onto current main (5d86714f; merge-tree d69faaa7; macOS):

  • actionlint (when workflows changed), shellcheck on the changed scripts and every changed scripts/test-*.sh pass on the merged tree.
  • Nothing was applied to any cloud.

@cristim
cristim merged commit 1d10f08 into main Oct 27, 2026
41 checks passed
@cristim
cristim deleted the docs/migration-eviction-comment branch October 27, 2026 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

effort/s Hours impact/internal Team-internal only priority/p3 Polish / idea / may never ship severity/low Minor harm triaged Item has been triaged type/docs Documentation urgency/eventually No deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(ci): database-migration concurrency comment claims an evicted migration leaves the run green, which is false

1 participant