GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — docs(contributing): define what counts as a breaking change by myasnikovdaniil · Pull Request #5253 · cozystack/cozystack

Conversation

myasnikovdaniil commented Nov 9, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link

Copy Markdown

Contributor

What this PR does

Contributing guide and PR template say how to mark a breaking change, ! after type/scope or a BREAKING CHANGE: footer, but nothing says what makes a change breaking. This PR adds that to docs/agents/contributing.md: after the upgrade an existing install, client or consumer is refused, loses something it used, or has to be edited to keep working.

The case that showed the gap is #4973. It was a fix that made a values shape the previous version ran fail at render time. It merged with a release note about it and without !, and no written rule decided it either way.

The definition follows what maintainers already mark with ! on merged fixes, it is not a new policy: #4847 (runtime refusal), #4639 and #4796 (refusal only for new or changed objects, existing ones keep working). Not breaking: a change that only accepts more, makes something broken work, refuses only what never worked even if it rendered or deployed, or changes how a working install runs while it keeps working. Refusing what never worked is how #4973 treats its own no-sizing pool, and it is why #4567 was a plain fix.

I walked the text against #4973 and #5083 (breaking, both merged without !) and against #4220, #4974, #3935 (not breaking). One place it differs from a marker: #4569 has !, but its value rendered and KubeVirt never admitted it, so by this text it is not breaking.

The text also says the fix type does not exempt a change, and an Action required line in the release note does not replace the marker. PR template tip line links to the new section (link works after merge, same as the backports one next to it).

A default change that degrades a working install without failing it is not covered. If it should be, please say so here.

contributors/README.md in cozystack/community repeats the marker syntax and has no definition either. No follow-up there yet, so the downstream boxes stay empty.

Not in this PR: labels.yml, pr-labeler.yaml, the release docs, and a check for Action required without the marker.

Screenshots

Downstream repositories

No downstream repository is affected by this change
cozystack/website - follow-up:
cozystack/terraform-provider-cozystack - follow-up:
cozystack/ansible-cozystack - follow-up:
cozystack/ccp - follow-up:
cozystack/talm - follow-up:
cozystack/cozyhr - follow-up:
cozystack/cozy-proxy - follow-up:
cozystack/cozystack-telemetry-server - follow-up:
cozystack/external-apps-example - follow-up:
cozystack/examples - follow-up:
cozystack/community - follow-up:

Release note

docs(contributing): the contributing guide now defines a breaking change (after the upgrade an existing install, client or consumer is refused, loses something it used, or has to be edited to keep working), says the `fix` type does not exempt a change and an `Action required` line in the release note does not replace the `!` marker. The PR template links to it.

Summary by CodeRabbit

Documentation
- Added clearer guidance on what qualifies as a breaking change, including examples of changes that are not breaking.
- Linked the pull request template’s breaking-change guidance to the contributing documentation.
- Clarified that commit markers and release notes are separate requirements.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions


          docs(contributing): define what counts as a breaking change

c9af8fb

The guide says how to mark a breaking change and never says what one
is. A fix that made a values shape the previous version rendered fail
at render time was merged with no marker, and review asked for a
release note instead, because neither this file nor the PR template
gives a test to apply.

The test is what an install that already runs gets after the upgrade:
refused, stripped of something it used, or made to edit its config.
The commit type says what a change is for, not what it does to an
install that is already running.

Assisted-by: LLM
Signed-off-by: Myasnikov Daniil <[email protected]>

myasnikovdaniil requested review from IvanHunters, Andrei Kvapil (kvaps), Aleksei Sviridkin (lexfrei), Timofei Larkin (lllamnyp) and Timur Tukaev (tym83) as code owners

November 9, 2026 13:07

github-actions Bot added size/S

This PR changes 10-29 lines, ignoring generated files

area/uncategorized

PR auto-labeler could not map title scope to a known area/*; please review

kind/documentation Categorizes issue or PR as related to documentation labels

Nov 9, 2026

coderabbitai Bot commented Nov 9, 2026 •

edited

Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link

Copy Markdown

Contributor

No actionable comments were generated in the recent review.

Walkthrough

The contributing documentation now defines what counts as a breaking change and explains how commit markers and release notes relate to that definition. The PR template links to the guidance.

Changes: Breaking-change guidance

Layer / File(s)	Summary
Define and link breaking-change criteria `.github/PULL_REQUEST_TEMPLATE.md`, `docs/agents/contributing.md`	The contributing documentation defines breaking changes, lists non-breaking cases, and clarifies commit-marker and release-note requirements. The PR template links to the guidance.

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

Change: Other

Suggested labels: kind/documentation

Merge Risk: Minimal · up to c9af8

The documentation clarifies breaking-change criteria without changing release automation. Existing guidance already explains how to mark breaking PRs, so this change is mergeable after normal checks.

Pre-merge checks: 5

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title "docs(contributing): define what counts as a breaking change" matches the main change. The PR adds a definition of a breaking change to docs/agents/contributing.md and links the PR template …
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: Title check

Explanation

The title "docs(contributing): define what counts as a breaking change" matches the main change. The PR adds a definition of a breaking change to docs/agents/contributing.md and links the PR template to it. The title names the scope (contributing docs) and the core action (defining breaking changes). It is concise and specific.

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. (2 skipped: 2 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

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

Source mode: Auto

Repository: cozystack/cozystack

Branch: main

File: .coderabbit.yaml

Commit: 1f35c26

Layers: Repository YAML

Review profile: CHILL

Plan: Advanced

Run ID: `9efcde46-2bf0-49b0-8a33-55d65150f998`

Commits

Reviewing files that changed from the base of the PR and between `1f35c26` and `c9af8fb`.

Files selected for processing: 2

`.github/PULL_REQUEST_TEMPLATE.md`

`docs/agents/contributing.md`

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

Reviewers

Andrei Kvapil (kvaps)

Awaiting requested review from kvaps

kvaps is a code owner

Timofei Larkin (lllamnyp)

Awaiting requested review from lllamnyp

lllamnyp is a code owner

Aleksei Sviridkin (lexfrei)

Awaiting requested review from lexfrei

lexfrei is a code owner

IvanHunters

Awaiting requested review from IvanHunters

IvanHunters is a code owner

Timur Tukaev (tym83)

Awaiting requested review from tym83

tym83 is a code owner

At least 1 approving review is required to merge this pull request.

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

area/uncategorized

PR auto-labeler could not map title scope to a known area/*; please review

kind/documentation

Categorizes issue or PR as related to documentation

size/S

This PR changes 10-29 lines, ignoring generated files

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

1 participant

Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.

GeezerVison

Conversation

myasnikovdaniil commented Nov 9, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What this PR does

Screenshots

Downstream repositories

Release note

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Nov 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

myasnikovdaniil commented Nov 9, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

There was an error while loading. Please reload this page.

coderabbitai Bot commented Nov 9, 2026 •

edited

Loading

Uh oh!

There was an error while loading. Please reload this page.