-
Notifications
You must be signed in to change notification settings - Fork 13
HYPERFLEET-531 - feat: Add Hyperfleet release process spike report #83
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?
Conversation
WalkthroughAdds a new Markdown spike report "HyperFleet Release Process" that defines a comprehensive release workflow: entry criteria, code-freeze and branching strategy (release branches, RCs, GA), multi-gate readiness checks, post-code-freeze bug handling (including hotfixes), artifacts and deliverables (container images, Helm charts, adapters, tags), documentation requirements (release notes, upgrade guides, API docs, changelogs, security artifacts), cadence (6-week regular cycle with ad-hoc releases), an MVP→Post-MVP migration plan (Prow → Konflux), and appendices/templates for release tracking and ad-hoc requests. Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
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.
Actionable comments posted: 4
🤖 Fix all issues with AI agents
In `@hyperfleet/docs/release-process-spike-report.md`:
- Around line 638-665: Replace emphasized section titles that use bold (e.g.,
"**1. Conduct Retrospectives and Identify Improvements**", "**2. Migrate to
Konflux for Official Releases**", "**Why Konflux:**", "**Migration Approach:**",
"**3. Additional Process Improvements**") with proper Markdown headings (e.g.,
"#", "##", or "###" as appropriate) so they are true headings instead of
emphasis; update the three numbered/section headings to at least "##" and the
subheadings like "Why Konflux:" and "Migration Approach:" to "###" for
consistent document structure and to satisfy MD036.
- Line 79: The fenced code block at the shown diff is missing a language
identifier and triggers MD040; update the opening fence from ``` to include a
language (e.g., change the opening fence to ```text or ```bash) so the block
becomes a tagged code fence; ensure the corresponding closing fence remains ```
and leave the block contents unchanged.
- Line 250: The fenced code block in
hyperfleet/docs/release-process-spike-report.md is missing a language identifier
(triggering MD040); update the opening fence from ``` to ```text (or another
appropriate language like ```text) for the code block that contains the flow
diagram (the sequence starting with "Bug Reported") so the linter recognizes it
as a code block and MD040 is satisfied.
- Line 303: A fenced code block in the markdown ends with a bare triple backtick
(```); MD040 requires a language identifier—update that fenced block (the
trailing/backtick-only block shown in the diff) to include a language token like
text (e.g., change ``` to ```text) so the block becomes ```text and closes
properly; ensure the same fenced block that contains "Developer → Code Review →
Release Owner → Automated Tests → Merge" is updated.
🧹 Nitpick comments (1)
hyperfleet/docs/release-process-spike-report.md (1)
400-400: Consider tightening wording (“under discussion”).
LanguageTool notes this as wordy; “proposed” or “being considered” reads tighter.✅ Suggested tweak
-- Note: Umbrella chart strategy (hyperfleet-chart repo) is under discussion +- Note: Umbrella chart strategy (hyperfleet-chart repo) is being considered
10f3fc8 to
692ff64
Compare
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.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@hyperfleet/docs/release-process-spike-report.md`:
- Line 199: Rename the section header "### 3.4 Documentation Completeness
(Mandatory)" to "### 3.3 Documentation Completeness (Mandatory)" and renumber
the following headers accordingly: change "3.5 Cross-Team Coordination" to "3.4
Cross-Team Coordination", "3.6 Security & Compliance" to "3.5 Security &
Compliance", and "3.7 Release Artifacts Verification" to "3.6 Release Artifacts
Verification" so the sequence reads 3.2 → 3.3 → 3.4 → 3.5 → 3.6; update any
in-file references to these section numbers if present.
692ff64 to
0d6b5cb
Compare
0d6b5cb to
5d202ca
Compare
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.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@hyperfleet/docs/release-process-spike-report.md`:
- Around line 98-104: The document has conflicting support-window language
between the "After GA" branching diagram and the "Section 2.4" paragraph; pick
one explicit policy and update both places to match (e.g., replace "support
window: 12 months" in the "After GA" diagram with the exact wording used in
Section 2.4, or update Section 2.4 to state "12 months" if that is the chosen
policy), and ensure the same canonical phrase appears in both the "After GA"
diagram block and the Section 2.4 text so the policy is unambiguous throughout.
🧹 Nitpick comments (1)
hyperfleet/docs/release-process-spike-report.md (1)
416-456: Make templates explicitly “examples” or use placeholders.The release notes and appendix templates use concrete versions/dates (e.g., v1.5.0, 2026‑05‑12, April 14, 2026), which can be misread as committed schedules. Consider labeling these blocks as “Example” and/or replacing with placeholders (e.g., vX.Y.Z, YYYY‑MM‑DD).
♻️ Example tweak (one option)
-# HyperFleet v1.5.0 Release Notes +# HyperFleet vX.Y.Z Release Notes (Example) -## [1.5.0] - 2026-05-12 +## [X.Y.Z] - YYYY-MM-DD -- Feature Freeze: April 14, 2026 -- Code Freeze: April 28, 2026 -- GA Target: May 12, 2026 +- Feature Freeze: YYYY-MM-DD +- Code Freeze: YYYY-MM-DD +- GA Target: YYYY-MM-DDAlso applies to: 508-529, 732-736
| After GA: | ||
| release-X.Y (maintained post-release) | ||
| │ | ||
| ├─── vX.Y.1 (Patch release via cherry-picks) | ||
| ├─── vX.Y.2 (Patch release) | ||
| └─── ... (support window: 12 months) | ||
| ``` |
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.
Align support window language (12 months vs. N‑2 / 6 months).
The branching diagram states a 12‑month support window, while Section 2.4 defines “N‑2 OR 6 months.” This is contradictory and will create policy ambiguity—please reconcile to a single, explicit policy and update both places.
Also applies to: 163-167
🤖 Prompt for AI Agents
In `@hyperfleet/docs/release-process-spike-report.md` around lines 98 - 104, The
document has conflicting support-window language between the "After GA"
branching diagram and the "Section 2.4" paragraph; pick one explicit policy and
update both places to match (e.g., replace "support window: 12 months" in the
"After GA" diagram with the exact wording used in Section 2.4, or update Section
2.4 to state "12 months" if that is the chosen policy), and ensure the same
canonical phrase appears in both the "After GA" diagram block and the Section
2.4 text so the policy is unambiguous throughout.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.