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

feat: add release-notes target #1734

Merged
merged 2 commits into from
May 18, 2023
Merged

feat: add release-notes target #1734

merged 2 commits into from
May 18, 2023

Conversation

vpavlin
Copy link
Member

@vpavlin vpavlin commented May 16, 2023

Description

Adds a make target to generate release notes based on commit messages.

Changes

  • new target added to Makefile

Example:

$ make release-notes 
## v0.17.0 (2023-05-16)

### Features

- add release-notes target ([ec9b222e](https://github.com/waku-org/nwaku/commit/ec9b222e))
- **cbindings:** first commit - waku relay ([#1632](https://github.com/waku-org/nwaku/issues/1632)) ([#1714](https://github.com/waku-org/nwaku/issues/1714)) ([2defbd23](https://github.com/waku-org/nwaku/commit/2defbd23))
- example using filter and lightpush ([#1720](https://github.com/waku-org/nwaku/issues/1720)) ([8987d4a3](https://github.com/waku-org/nwaku/commit/8987d4a3))
- configure protected topics via cli ([#1696](https://github.com/waku-org/nwaku/issues/1696)) ([16b44523](https://github.com/waku-org/nwaku/commit/16b44523))
- **mem-analysis:** Adding Dockerfile_with_heaptrack ([#1681](https://github.com/waku-org/nwaku/issues/1681)) ([9b9172ab](https://github.com/waku-org/nwaku/commit/9b9172ab))
- add metrics with msg size histogram ([#1697](https://github.com/waku-org/nwaku/issues/1697)) ([67e96ba8](https://github.com/waku-org/nwaku/commit/67e96ba8))
...

$ make release-notes

v0.17.0 (2023-05-16)

Features

@vpavlin
Copy link
Member Author

vpavlin commented May 16, 2023

I will remove this target from #1712. That one is not gonna get merge before release, but would like to use the release notes for 0.17.0, hence this separate PR

Copy link
Contributor

@alrevuelta alrevuelta left a comment

Choose a reason for hiding this comment

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

I usually do it "manually" with Generate release notes which does a great job including links to PRs, description etc. Outputs that are read by humans shouldn't imho be fully automated, but just leverage technology like "Generate release notes" does, which allows for some human corrections.

I believe @jm-clius also prefered it to be a bit more manual? To do some last minute corrections?

Not a blocker though, just an opinion from someone not in charge of the releases.

image

@vpavlin
Copy link
Member Author

vpavlin commented May 16, 2023

Yeah, it will stay manual for now. My plan here is to have a branch and tag with release candidate builds (binaries, container images..) prepped automatically, then have a manual step to review, edit and push final release/tag, but ideally the initial steps of release prep should be automatic.

Makefile Outdated Show resolved Hide resolved
@vpavlin
Copy link
Member Author

vpavlin commented May 16, 2023

@alrevuelta I tried with the Generate release notes and it does not look very good with semantic commits:

Screenshot from 2023-05-16 14-21-21

vs. sv4git
Screenshot from 2023-05-16 14-25-32

We can change the format if we need to and still manually edit things as much as we want:) But I personally like the format way more than what Generate release notes produces automatically

Copy link
Contributor

@rymnc rymnc left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for this

Copy link
Contributor

@jm-clius jm-clius left a comment

Choose a reason for hiding this comment

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

LGTM. I previously used the Generate release notes... but this required a significant amount of manual rewriting. This seems better and more configurable to make the manual intervention a bit less tedious. Good work. :)

@alrevuelta
Copy link
Contributor

@vpavlin thanks, indeed looks better than the github release notes.

@vpavlin vpavlin force-pushed the feat/release-notes branch 2 times, most recently from adc6be3 to cd1edd9 Compare May 18, 2023 08:28
@vpavlin vpavlin force-pushed the feat/release-notes branch from cd1edd9 to 99261e6 Compare May 18, 2023 08:36
Copy link
Collaborator

@Ivansete-status Ivansete-status left a comment

Choose a reason for hiding this comment

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

That PR is awesome. Thanks for it!

@vpavlin vpavlin merged commit ceb54b1 into master May 18, 2023
@vpavlin vpavlin deleted the feat/release-notes branch May 18, 2023 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants