[kerdofficial]

Release notes had drifted: some releases had written highlights, others only GitHub's generated list, headings and sections differed, and the generated list sometimes split into label categories such as "Other changes".

This adds one format for every release:

• .github/release-notes/vX.Y.Z.md holds the written notes, with fixed sections (Highlights, Updating, Compatibility, Platform requirements and limitations). All eight releases so far are rewritten into it.
• preflight refuses a tag without that file, and publish names the release Vectis X.Y.Z and appends GitHub's generated pull request list to the written notes.
• .github/release.yml drops the label categories, so the generated list is always one flat What's Changed list.
• RELEASING.md describes the format and when to use each section.

The published GitHub releases are updated to the same text separately.

Summary by CodeRabbit

• Documentation
  • Added release notes for Vectis versions 0.1.0 through 0.5.0, covering features, fixes, compatibility, updates, and platform requirements.
  • Updated release guidance with a consistent format and requirements for versioned notes.
• Release Process
  • Published releases now use the matching version’s notes, alongside GitHub’s generated pull request list.
  • Release checks verify that notes exist and include the expected version heading.

[coderabbitai]

No actionable comments were generated in the recent review.

Walkthrough

The pull request adds versioned release notes for Vectis 0.1.0 through 0.5.0. It updates release preflight checks and publishing to use notes that match the package version, and documents the release-notes requirements.

Changes: Versioned Release Process

Layer / File(s)	Summary
Versioned release notes .github/release-notes/v*.md, .github/release.yml	Adds release notes covering product changes, upgrade guidance, compatibility, and platform requirements across versions 0.1.0–0.5.0. Removes the previous changelog category mappings.
Validate and publish release notes .github/workflows/release.yml, RELEASING.md	Preflight checks that notes exist for the package version and have the matching heading. Publishing uses the versioned notes for the release name and body. The release guide documents the notes format and process.

Possibly related PRs

• kerddotdev/vectis#148: Bumps the package to v0.5.0, which matches the new v0.5.0 notes and version-matched release checks.
• kerddotdev/vectis#147: Implements the Cloudflare cloud migration described in the v0.5.0 release notes.
• kerddotdev/vectis#146: Bumps the package to v0.4.0, which matches the added v0.4.0 release notes.

Merge Risk: Minimal · up to adcf3

Releases retain their downloadable assets and combine written notes with generated changes. No merge-blocking issue was identified.

Architecture risk: Low · up to adcf3

The change affects 1 system.

Changed systems: RELEASING.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

• observed — RELEASING.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

• observed — Modified behavior in RELEASING.md: The release PR now adds a versioned release-notes file alongside the package version change. The publishing description now says the GitHub release is titled Vectis X.Y.Z and combines the written notes with the generated pull request list, rather than publishing only generated notes.
• observed — Modified behavior in RELEASING.md: Adds release-notes guidance covering the notes file’s role in preflight, publishing, and the website changelog; its required section order and content; and rules to use verified behavior, plain English, ASCII hyphens, and no manually written pull request list.
• observed — Modified behavior in .github/release-notes/v0.1.0.md: Adds release highlights describing one-job disposable VMs, per-connection opt-in automatic scheduling with a configurable concurrency limit of 1–16 (default five, with at most two macOS VMs), manual runners, Ubuntu 24.04 and macOS 26 ARM64 environments, experimental Windows 11 ARM64 setup, and configurable environment resources and resumable setup.
• observed — Modified behavior in .github/release-notes/v0.1.0.md: Documents GitHub account and repository setup, queued-job scheduling and scanning, bounded retries only when a successful run leaves its original job queued, repository/job management, administrator and contributor approval checks, and ARM workflow analysis and pull requests that Vectis does not merge.

Pre-merge checks: 5

Check name	Status	Explanation
Title check		The title clearly describes the main change: standardizing written notes for every release.
Description check		The description explains what changed and why, and it covers the release notes, workflow, configuration, and documentation updates. It does not use the template headings or include the checklist; the …
Docstring Coverage		No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Full details: Description check

Explanation

The description explains what changed and why, and it covers the release notes, workflow, configuration, and documentation updates. It does not use the template headings or include the checklist; the UI section appears not applicable.

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 with cyclomatic complexity of at least 2. 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. (10 skipped: 10 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

Recent review info

Run configuration

• Source mode: Auto
• Repository: Unavailable
• Branch: Unavailable
• File: No configuration file from this repository applied
• Commit: Unavailable
• Layers: Repository UI
• Review profile: CHILL
• Plan: Advanced
• Run ID: e1401142-63a9-4cef-9835-f354a6e22503

Commits

Reviewing files that changed from the base of the PR and between 22ae00b and adcf371.

Files selected for processing: 11

• .github/release-notes/v0.1.0.md
• .github/release-notes/v0.1.1.md
• .github/release-notes/v0.2.0.md
• .github/release-notes/v0.3.0.md
• .github/release-notes/v0.3.1.md
• .github/release-notes/v0.3.2.md
• .github/release-notes/v0.4.0.md
• .github/release-notes/v0.5.0.md
• .github/release.yml
• .github/workflows/release.yml
• RELEASING.md

Files with no reviewable changes: 1

• .github/release.yml

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.