Skip to content

docs(changelog): render unreleased fragments - #595

Merged
lusoris merged 1 commit into
masterfrom
chore/changelog-render-auto
Nov 10, 2026
Merged

lusoris merged 1 commit into
masterfrom
chore/changelog-render-auto

Conversation

@vmafx-release-bot

@vmafx-release-bot vmafx-release-bot Bot commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

Render-only update for unreleased changelog fragments in CHANGELOG.md.

Reproducer: bash scripts/release/concat-changelog-fragments.sh --write

Opened by the scheduled changelog render workflow (ADR-0252). Lands automatically via squash auto-merge once required checks pass.

Summary by Sourcery

Render unreleased changelog fragments and document the automated workflow that keeps CHANGELOG.md current.

Documentation:

  • Render the latest unreleased changelog fragments into CHANGELOG.md.
  • Document the changelog render-on-pull-request requirement and scheduled render workflow.

Summary by CodeRabbit

  • Documentation
    • Updated the unreleased changelog with notes on the documented minimum Python version, changelog checks for pull requests, and automated handling of render-only pull requests.
    • Added context for two ignored errors and noted the removal of a related exception. These updates describe changes to project maintenance and release processes; no end-user-facing product changes are listed.

Render-only commit generated by the scheduled render workflow (ADR-0252)
with bash scripts/release/concat-changelog-fragments.sh --write on
1f434b4.

Signed-off-by: vmafx-release-bot[bot] <340976456+vmafx-release-bot[bot]@users.noreply.github.com>
@vmafx-release-bot
vmafx-release-bot Bot requested a review from lusoris as a code owner November 10, 2026 18:18
@vmafx-release-bot
vmafx-release-bot Bot enabled auto-merge (squash) November 10, 2026 18:18
@sourcery-ai

sourcery-ai Bot commented Nov 10, 2026 •

Copy link
Copy Markdown

Reviewer's Guide

Documentation

Render the unreleased changelog fragments into CHANGELOG.md as a render-only update.

  • CHANGELOG.md L116, L147-148, L184

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai

coderabbitai Bot commented Nov 10, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The Unreleased changelog adds entries about Python version checks, changelog-render pull request rules and automation, and Lefthook error handling.

Changes: Unreleased changelog

Layer / File(s) Summary
Rendered changelog entries
CHANGELOG.md
Adds entries describing Python floor-pin checks, changelog-render pull request rules and automation, and ignored Lefthook errors with the HISS-07 exception removal.

Estimated code review effort: 2 (Simple) | ~5 minutes

Change: Other

Possibly related issues

  • VMAFx/pelorus#591 — Identifies this pull request as the scheduled changelog-render pull request.

Possibly related PRs

  • VMAFx/pelorus#541 — Regenerates the Unreleased changelog block using the same render script.
  • VMAFx/pelorus#590 — Defines the CI contract for render-only pull requests.
  • VMAFx/pelorus#592 — Adds the scheduled workflow that opens changelog-render pull requests.
Merge Risk: Minimal · up to 3cfd7

The changelog records existing changes, with no actionable merge-blocking risk identified.

Architecture risk: Low · up to 3cfd7

The change affects 1 system.

Changed systems: CHANGELOG.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

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

Before / after behavior

  • observed — Modified behavior in CHANGELOG.md: Adds a changelog entry describing a Renovate rule that keeps declared Python floor pins at the documented minimum and a build-config check that rejects mismatched pins or script floor-step names.
  • observed — Modified behavior in CHANGELOG.md: Adds entries documenting a pull-request changelog-render check based on the merge commit’s first parent and a six-hour fragment threshold for the hourly bot workflow. The check requires a render-only pull request before overdue changes land, constrains render and release pull-request contents, validates DCO trailers for squash auto-merge, and closes the bot’s pull request when the default branch is current.
  • observed — Modified behavior in CHANGELOG.md: Adds a changelog entry explaining the two ignored errors in the Lefthook session-record helpers and records removal of the HISS-07 exception; it notes that the upstream engine issue remains open and that a subsequent engine refresh must retain the lines.
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 clearly describes the main change: rendering unreleased changelog fragments.
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 with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
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. (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
Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between 1f434b4 and 3cfd71e.

Files selected for processing: 1

  • CHANGELOG.md

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

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes.

@codacy-production codacy-production Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

✅ No blocking issues noticed

No blocking findings were identified. The recommended renderer-output verification is still missing; no acceptance-criteria gap was independently confirmed from the supplied review data.

Test suggestions

  • Run the changelog fragment renderer and verify its output matches the committed CHANGELOG.md.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Run the changelog fragment renderer and verify its output matches the committed CHANGELOG.md.

Make this review better

TIP Add a ticket key to the branch or title so the reviewer can check the PR against it. Or tell us which ticket tracker you use here.

TIP How was this review? Give us feedback

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

@lusoris

lusoris commented Nov 10, 2026

Copy link
Copy Markdown
Contributor

Answering the Codacy review (pullrequestreview-5847095442): the suggested test already runs and passes on this head, so no change is needed.

  • CI step A changed CHANGELOG.md matches its fragments runs bash scripts/release/concat-changelog-fragments.sh --check whenever a pull request changes CHANGELOG.md; it passed on head 3cfd71e (job 130031583266).
  • python3 -I scripts/release/check-changelog-staleness.py --ref pointed at head 3cfd71e reports changelog render current (exit 0).
  • A separate manual render (bash scripts/release/concat-changelog-fragments.sh --write) on the same base 1f434b4 gives a byte-identical CHANGELOG.md (commit 738c0a9; git diff 738c0a9 3cfd71e -- CHANGELOG.md is empty).

@lusoris
lusoris merged commit 39ceb69 into master Nov 10, 2026
20 checks passed
@lusoris
lusoris deleted the chore/changelog-render-auto branch November 10, 2026 18:51
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