Let GitHub generates the release notes #3105
Conversation
Good! |
|
📱 Scan the QR code below to install the build (arm64 only) for this PR. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #3105 +/- ##
========================================
Coverage 75.96% 75.96%
========================================
Files 1636 1636
Lines 38629 38629
Branches 7467 7467
========================================
Hits 29345 29345
Misses 5395 5395
Partials 3889 3889 ☔ View full report in Codecov by Sentry. |
.github/workflows/fork-pr-notice.yml
Outdated
| @@ -25,7 +25,7 @@ jobs: | |||
| body: `Thank you for your contribution! Here are a few things to check in the PR to ensure it's reviewed as quickly as possible: | |||
|
|
|||
| - Your branch should be based on \`origin/develop\`, at least when it was created. | |||
| - There is a changelog entry in the \`changelog.d\` folder with [the Towncrier format](https://towncrier.readthedocs.io/en/latest/tutorial.html#creating-news-fragments). | |||
| - The title of the PR will be used for release notes, so it need to describe the change visible to the user. | |||
| @@ -55,7 +55,7 @@ Uncomment this markdown table below and edit the last line `|||`: | |||
| - [ ] UI change has been tested on both light and dark themes | |||
| - [ ] Accessibility has been taken into account. See https://github.com/element-hq/element-x-android/blob/develop/CONTRIBUTING.md#accessibility | |||
| - [ ] Pull request is based on the develop branch | |||
| - [ ] Pull request includes a new file under ./changelog.d. See https://github.com/element-hq/element-x-android/blob/develop/CONTRIBUTING.md#changelog | |||
| - [ ] Pull request title will be used in the release note, it clearly define what will change for the user | |||
There was a problem hiding this comment.
Should we mention the usage of labels here too?
There was a problem hiding this comment.
Danger will complain if the label is missing, so I do not think it worth it. Also I do not think external contributors using forks can add labels (not sure about this).
|
Type of change
Content
Remove the usage of towncrier and let GitHub generate the release note
Labels have been created: https://github.com/element-hq/element-x-android/labels?q=PR-
Motivation and context
No need to create towncrier file anymore and rely on GitHub
Use same DevX than on iOS. Inspired by element-hq/element-x-ios#2966
Limitation: during a release the file CHANGES.md will have to be updated after the release has been generated. We keep this file for an easy way to grep releases content.
Screenshots / GIFs
Tests
./changelog.dwill have to be deleted after the next release.Tested devices
NA
Checklist