Skip to content

chore(docs): cleanup and update release documentation - #3970

Open
Molter73 wants to merge 1 commit into
masterfrom
mauro/chore/update-release-md
Open

chore(docs): cleanup and update release documentation#3970
Molter73 wants to merge 1 commit into
masterfrom
mauro/chore/update-release-md

Conversation

@Molter73

Copy link
Copy Markdown
Member

Description

Update the release documentation in preparation of delegating this process to dedicated release engineers, the goal being they should be able to tag new collector versions with no additional input.

As part of the process and in order to reduce potential for confusion, some unused release scripts are being removed from the repo.

The status table showing the CI state in release branches are also removed, since they are unmaintained and might cause release engineers to wonder if they should update them.

Checklist

  • Investigated and inspected CI test results
  • Updated documentation accordingly

Automated testing

  • Added unit tests
  • Added integration tests
  • Added regression tests

If any of these don't apply, please comment below.

Testing Performed

Changes are docs only, CI is enough.

Update the release documentation in preparation of delegating this
process to dedicated release engineers, the goal being they should be
able to tag new collector versions with no additional input.

As part of the process and in order to reduce potential for confusion,
some unused release scripts are being removed from the repo.

The status table showing the CI state in release branches are also
removed, since they are unmaintained and might cause release engineers
to wonder if they should update them.
@coderabbitai

coderabbitai Bot commented Sep 11, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: 640741a5-8770-4841-b3c6-b5096b9974e2

📥 Commits

Reviewing files that changed from the base of the PR and between 708224a and 60437bb.

📒 Files selected for processing (6)
  • README.md
  • docs/release.md
  • utilities/docs/release.md
  • utilities/docs/tag-bumper.md
  • utilities/release.py
  • utilities/tag-bumper.py
💤 Files with no reviewable changes (5)
  • utilities/docs/tag-bumper.md
  • utilities/docs/release.md
  • utilities/release.py
  • utilities/tag-bumper.py
  • README.md

Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review.


📝 Summary

Summary by CodeRabbit

  • Documentation

    • Updated release guidance for minor, patch, and major releases.
    • Added instructions for CI workflows, release branches, tagging, and post-build version updates.
    • Removed outdated tag-annotation, Konflux suffix, and branch-manifest guidance.
    • Removed release utility and tag-bumping documentation.
    • Removed outdated Collector version entries from the README release table.
  • Chores

    • Removed the deprecated release-management and tag-bumping command-line utilities.

Walkthrough

The release documentation now describes the current branch, tag, and CI workflow. Obsolete release and tag-bumper utilities and their documentation were deleted. README release tracking entries for versions 3.22 through 3.24 were removed.

Changes

Release process updates

Layer / File(s) Summary
Release workflow documentation
README.md, docs/release.md
The release guide now documents CI triggers, manual branch creation, annotated tags, patch releases, and post-build version updates. Outdated release tracking and tag-annotation guidance was removed.
Obsolete release tooling removal
utilities/release.py, utilities/tag-bumper.py, utilities/docs/*
The release CLI, tag-bumper script, and their documentation were deleted, including branch and tag management, push handling, dry-run support, and command-line entry points.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: stringy

Merge Risk: ⚪ Minimal · up to 60437

The release documentation and obsolete tooling cleanup do not leave an identified merge-blocking risk.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Title check ✅ Passed The title clearly identifies the documentation cleanup and release documentation updates, which match the main changes.
Description check ✅ Passed The description explains the release-process changes, script removals, and status-table removal. It includes the checklist and testing information. The unchecked automated-test items are appropriate f…
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch mauro/chore/update-release-md

Comment @coderabbitai help to get the list of available commands.

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 27.43%. Comparing base (708224a) to head (60437bb).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3970   +/-   ##
=======================================
  Coverage   27.43%   27.43%           
=======================================
  Files          94       94           
  Lines        5406     5406           
  Branches     2535     2535           
=======================================
  Hits         1483     1483           
  Misses       3198     3198           
  Partials      725      725           
Flag Coverage Δ
collector-unit-tests 27.43% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

@Molter73
Molter73 marked this pull request as ready for review September 11, 2026 13:41
@Molter73
Molter73 requested a review from a team as a code owner September 11, 2026 13:41
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.

2 participants