Skip to content

Comments

Migrate release notes generation based on label#6127

Merged
aleksandar-apostolov merged 1 commit intodevelopfrom
chore/release-process-migration
Feb 4, 2026
Merged

Migrate release notes generation based on label#6127
aleksandar-apostolov merged 1 commit intodevelopfrom
chore/release-process-migration

Conversation

@aleksandar-apostolov
Copy link
Contributor

@aleksandar-apostolov aleksandar-apostolov commented Feb 4, 2026

Goal

Align stream-chat-android's release process with stream-video-android and stream-core-android by migrating to label-based release notes.

Testing

Will be tested on the new release

Implementation

Added

  • .github/release.yaml — GitHub auto-generates release notes from PR labels
  • .github/workflows/pr-quality.yml — Enforces PR labels via conventions workflow

Updated

  • .github/pull_request_template.md — Matches video SDK style, removed manual changelog requirement

Labels Created (via GitHub API)

All 11 pr:* labels matching video/core:

  • pr:breaking-change, pr:new-feature, pr:bug, pr:improvement
  • pr:documentation, pr:dependencies, pr:internal, pr:ci, pr:test
  • pr:demo-app, pr:ignore-for-release

Notes

  • CHANGELOG.md remains for history — not deleted
  • Uses [email protected] (same version as existing pr-checks.yml)

Summary by CodeRabbit

  • Chores
    • Updated pull request template with simplified formatting and clearer submission guidance.
    • Added automated release configuration for consistent changelog categorization based on pull request labels.
    • Implemented pull request quality assurance workflow automation.

- Add release.yaml for GitHub auto-generated release notes
- Add pr-quality.yml workflow using conventions for label enforcement
- Update PR template to match video SDK style
- Remove manual changelog requirement from checklist

Labels created separately:
pr:breaking-change, pr:new-feature, pr:bug, pr:improvement,
pr:documentation, pr:dependencies, pr:internal, pr:ci, pr:test,
pr:demo-app, pr:ignore-for-release
@aleksandar-apostolov aleksandar-apostolov requested a review from a team as a code owner February 4, 2026 09:27
@aleksandar-apostolov aleksandar-apostolov added the pr:ci CI changes label Feb 4, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 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
Contributor

github-actions bot commented Feb 4, 2026

SDK Size Comparison 📏

SDK Before After Difference Status
stream-chat-android-client 5.26 MB 5.26 MB 0.00 MB 🟢
stream-chat-android-offline 5.48 MB 5.48 MB 0.00 MB 🟢
stream-chat-android-ui-components 10.63 MB 10.63 MB 0.00 MB 🟢
stream-chat-android-compose 12.84 MB 12.84 MB 0.00 MB 🟢

@coderabbitai
Copy link

coderabbitai bot commented Feb 4, 2026

Walkthrough

Updates GitHub configuration files: simplifies the PR template by removing emoji prefixes from section headings, refines the PR checklist, adds release changelog schema for categorizing changes by labels, and introduces a new GitHub Actions workflow that delegates PR quality checks to an external reusable workflow.

Changes

Cohort / File(s) Summary
PR Template
.github/pull_request_template.md
Removed emoji prefixes from section headings (Goal, Implementation, Testing); updated Slack channel requirement language; removed changelog and release notes checklist items; added optional patch submission guidance with example template.
Release Configuration
.github/release.yaml
New file defining changelog schema with PR label-based categorization (Breaking Changes, New Features, Bug Fixes, Improvements, Documentation, Dependencies, Internal, Demo App, Other Changes) and exclusion filters for authors and labels.
GitHub Actions Workflow
.github/workflows/pr-quality.yml
New workflow file that triggers on PR events and delegates PR checklist validation to external reusable workflow from GetStream/stream-build-conventions-android at v0.7.1.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Suggested reviewers

  • VelikovPetar

Poem

🐰 Templates neat, configurations bright,
Labels organized, release flow just right,
External workflows handle the tests,
PR quality checks put our process to best! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The PR title 'chore: migrate to label-based release notes' accurately describes the main change—migrating to a label-based release process.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The PR description covers the primary objectives (goal, implementation, testing) but lacks some template sections and does not follow the exact template structure.

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

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/release-process-migration

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

sonarqubecloud bot commented Feb 4, 2026

Copy link
Contributor

@gpunto gpunto left a comment

Choose a reason for hiding this comment

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

🎉

- [ ] PR is linked to the GitHub issue it resolves

#### Code & documentation
- [ ] Changelog is updated with client-facing changes
Copy link
Contributor

Choose a reason for hiding this comment

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

CHANGELOG.md remains for history — not deleted

About this, do we really need to keep the changelog file? In the end, the change log was posted as part of the releases anyway so it wouldn't be lost.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe we'll delete all of them in video as well.

@aleksandar-apostolov aleksandar-apostolov merged commit 24e88e6 into develop Feb 4, 2026
15 of 20 checks passed
@aleksandar-apostolov aleksandar-apostolov deleted the chore/release-process-migration branch February 4, 2026 11:25
@aleksandar-apostolov aleksandar-apostolov changed the title chore: migrate to label-based release notes Migrate release notes generation based on label Feb 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr:ci CI changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants