Skip to content

Remove legacy changelog and deprecation files#6311

Merged
VelikovPetar merged 2 commits intov7from
remove-changelog
Mar 30, 2026
Merged

Remove legacy changelog and deprecation files#6311
VelikovPetar merged 2 commits intov7from
remove-changelog

Conversation

@andremion
Copy link
Copy Markdown
Contributor

@andremion andremion commented Mar 30, 2026

Goal

Remove manually-maintained CHANGELOG.md, CHANGELOG_MODEL.md, and DEPRECATIONS.md files that are no longer needed now that release notes are auto-generated via .github/release.yaml and PR labels.

Implementation

  • Deleted CHANGELOG.md, CHANGELOG_MODEL.md, and DEPRECATIONS.md
  • Updated CONTRIBUTING.md to remove references to the deleted files
  • Updated AGENTS.md to:
    • Remove DEPRECATIONS.md references from API stability and documentation guidance
    • Replace changelog/deprecation checklist items with PR label guidance
    • Remove "changelog updates" from module boundary note

Testing

  • Verify that .github/release.yaml is still in place and correctly configured for auto-generated release notes
  • Confirm no CI workflows, Gradle tasks, or scripts referenced the deleted files

Summary by CodeRabbit

  • Documentation
    • Updated repository contribution guidelines and developer guidance documentation.
    • Simplified internal documentation structure for changelog and deprecation tracking.

- Delete `CHANGELOG.md` and `CHANGELOG_MODEL.md`.
- Update `CONTRIBUTING.md` and `AGENTS.md` to remove instructions and references related to maintaining the changelog.
…nges.

- Delete `DEPRECATIONS.md`, which previously tracked SDK deprecation timelines and migration paths.
- Update `AGENTS.md` to direct documentation of deprecations and behavioral shifts to release notes via PR labels instead of the deprecated file.
- Update the developer checklist to prioritize PR labeling (e.g., `pr:breaking-change`) for user-visible changes.
@andremion andremion requested a review from a team as a code owner March 30, 2026 12:56
@andremion andremion added the pr:ignore-for-release Exclude from release notes label Mar 30, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 30, 2026

PR checklist ✅

All required conditions are satisfied:

  • Title length is OK (or ignored by label).
  • At least one pr: label exists.
  • Sections ### Goal, ### Implementation, and ### Testing are filled.

🎉 Great job! This PR is ready for review.

@github-actions
Copy link
Copy Markdown
Contributor

SDK Size Comparison 📏

SDK Before After Difference Status
stream-chat-android-client 5.25 MB 5.68 MB 0.43 MB 🟡
stream-chat-android-ui-components 10.60 MB 10.99 MB 0.39 MB 🟡
stream-chat-android-compose 12.81 MB 12.11 MB -0.70 MB 🚀

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 30, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 2855abbf-8d0b-427e-b924-bed4e35208b7

📥 Commits

Reviewing files that changed from the base of the PR and between 0a6ceb0 and b8b84c7.

📒 Files selected for processing (5)
  • AGENTS.md
  • CHANGELOG.md
  • CHANGELOG_MODEL.md
  • CONTRIBUTING.md
  • DEPRECATIONS.md
💤 Files with no reviewable changes (2)
  • CONTRIBUTING.md
  • CHANGELOG_MODEL.md

Walkthrough

These changes shift release notes management from manual changelog files toward a PR/release-label-based system. The CHANGELOG_MODEL.md template file is entirely removed, and documentation references to CHANGELOG.md and DEPRECATIONS.md are removed from contribution guidelines and agent instructions.

Changes

Cohort / File(s) Summary
Documentation Restructuring
AGENTS.md, CONTRIBUTING.md
Removed references to changelog and deprecation documentation files. Updated guidance to use PR/release labels for release notes instead of manual changelog updates.
Template Removal
CHANGELOG_MODEL.md
Entire unreleased changelog template file deleted, which previously defined package-specific changelog sections.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 The labels hop in to save the day,
No more changelog files in the way,
Deprecations fade, templates take flight,
Release notes automated—oh what a sight! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: removing legacy changelog and deprecation files.
Description check ✅ Passed The description covers Goal, Implementation, and Testing sections as required by the template. UI Changes and Contributor/Reviewer Checklists are not applicable to this documentation-only change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch remove-changelog

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

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

@sonarqubecloud
Copy link
Copy Markdown

@VelikovPetar VelikovPetar merged commit 18dbf19 into v7 Mar 30, 2026
17 checks passed
@VelikovPetar VelikovPetar deleted the remove-changelog branch March 30, 2026 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr:ignore-for-release Exclude from release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants