Skip to content

chore: update release docs - #1749

Open
Molter73 wants to merge 1 commit into
mainfrom
mauro/chore/update-release-docs
Open

chore: update release docs#1749
Molter73 wants to merge 1 commit into
mainfrom
mauro/chore/update-release-docs

Conversation

@Molter73

@Molter73 Molter73 commented Sep 11, 2026

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.

Checklist

  • Patch has a change log entry OR does not need one.
  • 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 should be enough.

Summary by CodeRabbit

  • Documentation
    • Release documentation now links directly to automated release workflows.
    • Manual patch releases are directed to the tagging procedure.
    • Tagging guidance now defines release and patch variables and uses annotated tags with release messages.
    • Separate patch-release instructions and the release-engineer configuration prerequisite have been removed.

@Molter73
Molter73 requested a review from a team as a code owner September 11, 2026 13:32
@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: Path: .coderabbit.yml

Review profile: CHILL

Plan: Enterprise

Run ID: b876adc9-d3da-4ba5-a5be-f8a70159377f

📥 Commits

Reviewing files that changed from the base of the PR and between 26c7079 and 5ca6d42.

📒 Files selected for processing (1)
  • docs/release.md

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


📝 Walkthrough

Walkthrough

The release guide now links automated release workflows directly and updates manual release instructions to use a variable-based annotated tagging procedure.

Changes

Release documentation

Layer / File(s) Summary
Workflow and patch guidance
docs/release.md
Automated release workflow names link to their workflow files. Manual patch releases point directly to the tagging procedure.
Manual tagging procedure
docs/release.md
The procedure defines release variables, updates the release branch, creates an annotated versioned tag with a release message, and pushes it. Obsolete configuration and separate patch-release instructions are removed.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: erthalion

Merge Risk: ⚪ Minimal · up to 5ca6d

The release documentation updates are consistent with the release workflow and are ready to merge.

🚥 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.
Description check ✅ Passed The description explains the documentation-only change, marks the non-applicable test types, and provides a testing rationale. The checklist incorrectly leaves “Updated documentation accordingly” unch…
Title check ✅ Passed The title clearly and concisely identifies the main change: updating the release documentation.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • 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-docs

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

@Molter73
Molter73 marked this pull request as draft September 11, 2026 13:32
@Molter73
Molter73 force-pushed the mauro/chore/update-release-docs branch from ca2c0f2 to e8cd111 Compare September 11, 2026 13:34
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.
@Molter73
Molter73 force-pushed the mauro/chore/update-release-docs branch from e8cd111 to 5ca6d42 Compare September 11, 2026 13:34
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 33.40%. Comparing base (26c7079) to head (5ca6d42).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1749   +/-   ##
=======================================
  Coverage   33.40%   33.40%           
=======================================
  Files          22       22           
  Lines        3628     3628           
  Branches     3628     3628           
=======================================
  Hits         1212     1212           
  Misses       2407     2407           
  Partials        9        9           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Molter73
Molter73 marked this pull request as ready for review September 11, 2026 13:42
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