Skip to content

Commit 24e88e6

Browse files
chore: migrate to label-based release notes (#6127)
- 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
1 parent d36fb32 commit 24e88e6

3 files changed

Lines changed: 61 additions & 6 deletions

File tree

.github/pull_request_template.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
### 🎯 Goal
1+
### Goal
22

33
_Describe why we are making this change_
44

5-
### 🛠 Implementation details
5+
### Implementation
66

77
_Describe the implementation_
88

@@ -35,7 +35,7 @@ _Add relevant videos_
3535
</tbody>
3636
</table>
3737

38-
### 🧪 Testing
38+
### Testing
3939

4040
_Explain how this change can be tested (or why it can't be tested)_
4141

@@ -57,11 +57,11 @@ Provide the patch code here
5757
#### General
5858
- [ ] I have signed the [Stream CLA](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform) (required)
5959
- [ ] Assigned a person / code owner group (required)
60-
- [ ] Thread with the PR link started in a respective Slack channel (#android-chat-core or #android-chat-ui) (required)
60+
- [ ] Thread with the PR link started in a respective Slack channel (required internally)
61+
- [ ] PR targets the `develop` branch
6162
- [ ] PR is linked to the GitHub issue it resolves
6263

6364
#### Code & documentation
64-
- [ ] Changelog is updated with client-facing changes
6565
- [ ] New code is covered by unit tests
6666
- [ ] Comparison screenshots added for visual changes
6767
- [ ] Affected documentation updated (KDocs, docusaurus, tutorial)
@@ -72,7 +72,6 @@ Provide the patch code here
7272
- [ ] UI Changes correct (before & after images)
7373
- [ ] Bugs validated (bugfixes)
7474
- [ ] New feature tested and works
75-
- [ ] Release notes and docs clearly describe changes
7675
- [ ] All code we touched has new or updated KDocs
7776
- [ ] Check the SDK Size Comparison table in the CI logs
7877

.github/release.yaml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
changelog:
2+
exclude:
3+
labels:
4+
- "pr:ignore-for-release"
5+
authors:
6+
- "github-actions[bot]"
7+
- "stream-public-bot"
8+
categories:
9+
- title: Breaking Changes 🛠
10+
labels:
11+
- "pr:breaking-change"
12+
- title: New Features 🎉
13+
labels:
14+
- "pr:new-feature"
15+
- title: Bug Fixes 🐛
16+
labels:
17+
- "pr:bug"
18+
- title: Improvements ✨
19+
labels:
20+
- "pr:improvement"
21+
- title: Documentation 📚
22+
labels:
23+
- "pr:documentation"
24+
- title: Dependencies 📦
25+
labels:
26+
- "pr:dependencies"
27+
- title: Internal 🧪
28+
labels:
29+
- "pr:internal"
30+
- "pr:ci"
31+
- "pr:test"
32+
- title: Demo App 🧩
33+
labels:
34+
- "pr:demo-app"
35+
- title: Other Changes
36+
labels:
37+
- "*"

.github/workflows/pr-quality.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: PR checklist
2+
3+
on:
4+
pull_request:
5+
types: [ opened, edited, synchronize, labeled, unlabeled, reopened ]
6+
7+
permissions:
8+
contents: read
9+
pull-requests: write
10+
issues: write
11+
12+
concurrency:
13+
group: ${{ github.workflow }}-${{ github.ref }}
14+
cancel-in-progress: true
15+
16+
jobs:
17+
pr-checklist:
18+
uses: GetStream/stream-build-conventions-android/.github/workflows/pr-quality.yml@v0.7.1
19+
secrets: inherit

0 commit comments

Comments
 (0)