Skip to content
New issue

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

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

Already on GitHub? # to your account

chore: Sunset towncrier release notes #976

Merged
merged 1 commit into from
Oct 12, 2023

Conversation

ogenev
Copy link
Member

@ogenev ogenev commented Oct 11, 2023

What was wrong?

Towncrier is not used anymore for generating release notes. We switched to conventional commits and GitHub releases.

How was it fixed?

  • remove newsfragment folder
  • Update book commit message guide.
  • Remove duplicated files from docs folder
  • Update the PR template

To-Do

  • Clean up commit history

@ogenev ogenev self-assigned this Oct 11, 2023
@ogenev ogenev added the flamingo Maintenance or downtime for the person on Flamingo rotation to tackle label Oct 11, 2023
@ogenev ogenev marked this pull request as ready for review October 11, 2023 07:36
@ogenev ogenev requested review from njgheorghita and carver October 11, 2023 07:47
Copy link
Collaborator

@njgheorghita njgheorghita left a comment

Choose a reason for hiding this comment

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

🚢

@@ -5,4 +5,4 @@
### To-Do

[//]: # (Stay ahead of things, add list items here!)
- [ ] Clean up commit history
- [ ] Clean up commit history and use conventional commits
Copy link
Collaborator

Choose a reason for hiding this comment

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

I just closed #953 since it requires a 3rd-party orb, usage of which is not authorized (and will not be) on our circleci account. But I do think adding a lint step to our ci build which validates this is better than simply stating that commits should be "conventional" (tracked in #979). Either way, it's not a blocker for this pr and this is great for the time being.

One thing I would change here is to just make this a hyperlink to "https://www.conventionalcommits.org/en/v1.0.0/" for easy reference

@@ -18,16 +18,22 @@ written. Once things are complete, you can `git reset master` to unstage all
of the changes you've made, and then re-commit them in small chunks using `git
add -p`.

## Commit Messages
### Commit Messages
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nice catch that our docs were getting out of date here!

Copy link
Collaborator

@carver carver left a comment

Choose a reason for hiding this comment

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

💯

@ogenev ogenev merged commit eabee13 into ethereum:master Oct 12, 2023
@ogenev ogenev deleted the sunset-towncrier branch October 12, 2023 07:02
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
flamingo Maintenance or downtime for the person on Flamingo rotation to tackle
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants