Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace Towncrier with GitHub releases + labels. #2966

Merged
merged 5 commits into from
Jun 25, 2024

Conversation

pixlwave
Copy link
Member

We weren't using Towncrier very well so this PR replaces it with the use of GitHub's generated release notes along with a configuration that will categorise each entry based upon one of the following labels being applied:

Labels added here: https://github.com/element-hq/element-x-ios/labels?q=pr-

These labels can be added after the PR is merged, so long as they're there before the release is made.

The second commit removes Towncrier. I made a second repo to figure the flow out, but not sure how to validate the changes on EX other than wait for the next release and tidy up anything that comes out of that.

@pixlwave pixlwave added the pr-build for changes related to build, tools, CI/CD label Jun 25, 2024
@pixlwave pixlwave requested a review from a team as a code owner June 25, 2024 09:25
@pixlwave pixlwave requested review from Velin92 and stefanceriu and removed request for a team June 25, 2024 09:25
Copy link

github-actions bot commented Jun 25, 2024

Warnings
⚠️ Some of the commits are missing ticket numbers. Please consider squashing all commits that don't have a tracking number.

Generated by 🚫 Danger Swift against 3c6540e

Copy link
Member

@Velin92 Velin92 left a comment

Choose a reason for hiding this comment

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

LGTM but what happens if a pr has multiple labels? Would it appear under multiple categories?

@pixlwave
Copy link
Member Author

Oh yeah, Stefan asked this. Let's try in the test repo.

Copy link
Member

@stefanceriu stefanceriu left a comment

Choose a reason for hiding this comment

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

👏

@pixlwave
Copy link
Member Author

LGTM but what happens if a pr has multiple labels? Would it appear under multiple categories?

This PR had 3 tags, and the first one (I assume from the release.yml ordering) got chosen.

Copy link

codecov bot commented Jun 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.05%. Comparing base (567f22b) to head (c82691d).

Current head c82691d differs from pull request most recent head 3c6540e

Please upload reports for the commit 3c6540e to get more accurate results.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #2966      +/-   ##
===========================================
+ Coverage    77.98%   78.05%   +0.06%     
===========================================
  Files          693      693              
  Lines        54172    54172              
===========================================
+ Hits         42248    42283      +35     
+ Misses       11924    11889      -35     
Flag Coverage Δ
unittests 68.91% <ø> (+0.06%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@pixlwave pixlwave removed the pr-build for changes related to build, tools, CI/CD label Jun 25, 2024
@pixlwave pixlwave changed the title Replace Towncrier with GitHub releases + labels. Replace Towncrier with GitHub releases + labels. This is a really long title that gets trunca… Jun 25, 2024
@pixlwave pixlwave changed the title Replace Towncrier with GitHub releases + labels. This is a really long title that gets trunca… Replace Towncrier with GitHub releases + labels. Jun 25, 2024
@pixlwave pixlwave added the pr-build for changes related to build, tools, CI/CD label Jun 25, 2024
Stop requesting a changelog file.
@pixlwave pixlwave enabled auto-merge (squash) June 25, 2024 10:41
@pixlwave pixlwave disabled auto-merge June 25, 2024 10:48
Copy link

@pixlwave pixlwave enabled auto-merge (squash) June 25, 2024 10:59
@pixlwave pixlwave merged commit 82823c9 into develop Jun 25, 2024
5 checks passed
@pixlwave pixlwave deleted the doug/🔥towncrier🔥 branch June 25, 2024 11:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-build for changes related to build, tools, CI/CD
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants