Skip to content

docs(DEVS-1547): add v9 upgrade guide and breaking-change release category - #169

Merged
0x46616c6b merged 2 commits into
mainfrom
DEVS-1547-v9-upgrade-guide
Sep 30, 2026
Merged

0x46616c6b merged 2 commits into
mainfrom
DEVS-1547-v9-upgrade-guide

Conversation

@0x46616c6b

Copy link
Copy Markdown
Contributor

https://mitarbeiterapp.atlassian.net/browse/DEVS-1547

Type of Change

  • Bugfix
  • Enhancement / new feature
  • Refactoring
  • Documentation

Description

Goal: give callers clear upgrade guidance for the upcoming breaking v9 release (docker-registry renamed to docker-registries in #165).

  • README: new "Upgrading → From v8 to v9" section with a before/after snippet, examples pinned to @v9, and a note under "Releasing new versions" to link the upgrade entry in major release notes.
  • Release Drafter: new "💥 Breaking Changes" category driven by the existing major label, which now also triggers the major bump. feature moves to a minor bump, minor/patch labels are honoured.

How to review: read the upgrade section for accuracy against action.yml, and check the label mapping in .github/release-drafter.yml.

Follow-up before publishing v9: #165 is labelled feature only. It needs the major label, otherwise the draft resolves to v8.3.0.

Checklist

  • Write tests
  • Make sure all tests pass
  • Update documentation
  • Review the Contributing Guideline and sign CLA
  • Reference relevant issue(s) and close them after merging

🤖 Generated with Claude Code

…se category

The docker-registry input was renamed to docker-registries, which breaks
existing callers. Document the migration in the README and let release
drafter surface breaking PRs via the existing `major` label, so `feature`
no longer implies a major bump.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@0x46616c6b
0x46616c6b marked this pull request as ready for review September 30, 2026 11:22
@0x46616c6b
0x46616c6b requested review from a team as code owners September 30, 2026 11:22
@0x46616c6b
0x46616c6b requested review from axdotl, kaitimmer, ricoberger and timkante and a balanced review from Copilot September 30, 2026 11:22

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

The upgrade example is misleading and major-feature PRs would be duplicated across release-note categories.

Review effort: Balanced
Findings: 1 Medium severity · 2 Low severity

Open (3)
What changed in this PR

Adds v9 migration guidance and configures release categorization/versioning for breaking changes.

Changes:

  • Documents the docker-registry → docker-registries migration.
  • Updates examples to v9.
  • Maps release labels to semantic version increments.
File Description
README.md Adds v9 upgrade and release guidance.
.github/​release-drafter.yml Adds breaking-change categorization and label-based versioning.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .github/release-drafter.yml
Comment thread README.md Outdated
Comment thread README.md Outdated
Show the @v8 to @v9 reference bump in the upgrade snippet, clarify that
default-registry callers still need to bump the version, and make the
Breaking Changes category exclusive so major PRs are not listed twice.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@0x46616c6b
0x46616c6b merged commit bf3edfa into main Sep 30, 2026
10 checks passed
@0x46616c6b
0x46616c6b deleted the DEVS-1547-v9-upgrade-guide branch September 30, 2026 11:38
@github-actions github-actions Bot locked and limited conversation to collaborators Sep 30, 2026
@0x46616c6b 0x46616c6b added the chore Pull requests that are chores label Sep 30, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

chore Pull requests that are chores

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants