docs(changelog): release notes for v0.17.0 #1735

vpavlin · 2023-05-16T12:47:45Z

Description

This PR updates CHANGELOG for release v0.17.0

Please check if the changelog looks ok and propose highlights!

Ivansete-status · 2023-05-16T13:11:04Z

It does look really good. Thanks for it!
However, I think it also worth mentioning the next.

C Bindings support
feat(cbindings): first commit - waku relay (#1632) #1714
Heaptrack support
feat(mem-analysis): Adding Dockerfile_with_heaptrack #1681
docs: adding new tutorial on how to handle heaptrack with nim waku #1719
The topics parameter being deprecated in wakunode2 app in favour of the topic parameter
fix: wakunode2 config. adding new 'topic' config parameter. #1727

Ivansete-status

LGTM! Thanks!

jm-clius

Looks good, but I only see changes included up to 14 April (and not 16 May as we would want)?

jm-clius · 2023-05-16T13:28:49Z

CHANGELOG.md

+Release highlights:
+* New rest api for Waku Store protocol
+* Removed Waku2 Swap protocol
+* New Filter protocol implentations


Suggested change

* New Filter protocol implentations

* New Filter protocol implementation. See [12/WAKU2-FILTER](https://rfc.vac.dev/spec/12/).

In general I think it's a good idea to link people to documents where available.

jm-clius · 2023-05-16T13:38:57Z

CHANGELOG.md

+- bump nim-libp2p 53b060f ([#1633](https://github.com/waku-org/nwaku/issues/1633)) ([11ff93c2](https://github.com/waku-org/nwaku/commit/11ff93c2))
+- added testcommon target to makefile ([048ca45d](https://github.com/waku-org/nwaku/commit/048ca45d))
+- increase meta size to 64 bytes + tests ([#1629](https://github.com/waku-org/nwaku/issues/1629)) ([1f793756](https://github.com/waku-org/nwaku/commit/1f793756))
+- **enr:** move waku enr multiaddr to typedrecod and builder extensions ([2ffd2f80](https://github.com/waku-org/nwaku/commit/2ffd2f80))


Suggested change

- **enr:** move waku enr multiaddr to typedrecod and builder extensions ([2ffd2f80](https://github.com/waku-org/nwaku/commit/2ffd2f80))

- **enr:** move waku enr multiaddr to typedrecord and builder extensions ([2ffd2f80](https://github.com/waku-org/nwaku/commit/2ffd2f80))

jm-clius · 2023-05-16T13:40:09Z

CHANGELOG.md

+- **rln-relay:** buildscript bad cp ([#1636](https://github.com/waku-org/nwaku/issues/1636)) ([bd9857c1](https://github.com/waku-org/nwaku/commit/bd9857c1))
+- **wakunode2:** fix main warnings and drop swap support ([f95147f5](https://github.com/waku-org/nwaku/commit/f95147f5))
+- **rln-relay:** on chain registration ([#1627](https://github.com/waku-org/nwaku/issues/1627)) ([b1bafda2](https://github.com/waku-org/nwaku/commit/b1bafda2))
+- connect instead dial relay peers ([#1622](https://github.com/waku-org/nwaku/issues/1622)) ([85f33a8e](https://github.com/waku-org/nwaku/commit/85f33a8e))


Suggested change

- connect instead dial relay peers ([#1622](https://github.com/waku-org/nwaku/issues/1622)) ([85f33a8e](https://github.com/waku-org/nwaku/commit/85f33a8e))

- connect instead of dialing relay peers ([#1622](https://github.com/waku-org/nwaku/issues/1622)) ([85f33a8e](https://github.com/waku-org/nwaku/commit/85f33a8e))

jm-clius · 2023-05-16T13:45:07Z

CHANGELOG.md

+- **rest-api-store:** new rest api to retrieve store waku messages ([#1611](https://github.com/waku-org/nwaku/issues/1611)) ([#1630](https://github.com/waku-org/nwaku/issues/1630)) ([b2acb54d](https://github.com/waku-org/nwaku/commit/b2acb54d))
+- **node:** added waku node builder type ([e931fa5d](https://github.com/waku-org/nwaku/commit/e931fa5d))
+- dos protected topic relay msgs based on meta field ([#1614](https://github.com/waku-org/nwaku/issues/1614)) ([c26dcb2b](https://github.com/waku-org/nwaku/commit/c26dcb2b))
+- further filter improvements ([#1617](https://github.com/waku-org/nwaku/issues/1617)) ([d920b973](https://github.com/waku-org/nwaku/commit/d920b973))


This may require too much manual intervention, but perhaps where several items are obviously related to increments for the same feature it may be possible to just merge them into a single entry? In this case "new filter protocol implementation", perhaps with a links to the corresponding PRs and commits listed afterwards. WDYT?

Hmm, it would be great if we used scope in PR/commit messages and then grouped by it automatically. We could go over the release notes manually and group things together, sure. But is that the best use of time?:D

But is that the best use of time?:D

I wouldn't do it for all commits, but would consider for major features where it's easy to do. But, yeah, this shouldn't be a big time ask so I don't have strong feelings here.

jm-clius · 2023-05-16T13:45:34Z

CHANGELOG.md

+- further filter improvements ([#1617](https://github.com/waku-org/nwaku/issues/1617)) ([d920b973](https://github.com/waku-org/nwaku/commit/d920b973))
+- **common:** added extensible implementation of the enr typed record ([ac56e1dc](https://github.com/waku-org/nwaku/commit/ac56e1dc))
+- **rln-relay:** fetch release from zerokit ci, or build ([#1603](https://github.com/waku-org/nwaku/issues/1603)) ([179be681](https://github.com/waku-org/nwaku/commit/179be681))
+- **filter-v2:** new filter protocol increment - message handling and clients ([#1600](https://github.com/waku-org/nwaku/issues/1600)) ([be446b98](https://github.com/waku-org/nwaku/commit/be446b98))


See comment above about maybe merging the most obvious increments for the same feature into a single entry.

jm-clius · 2023-05-16T13:47:06Z

CHANGELOG.md

+
+Release highlights:
+* new rest api for Waku Store protocol has been added
+* Waku2 Swap protocol has been removed


I wouldn't include this in the highlights list.

jm-clius · 2023-05-16T13:47:32Z

CHANGELOG.md

+* Waku2 Swap protocol has been removed
+* new Filter protocol implentations has been incorporated
+* initial C bindings support has been merged
+* support for Heaptrack to investigate memory utilization has been added


perhaps link to the tutorial here?

jm-clius · 2023-05-16T13:51:58Z

CHANGELOG.md

+* new Filter protocol implentations has been incorporated
+* initial C bindings support has been merged
+* support for Heaptrack to investigate memory utilization has been added
+* the `topics` parameter has been deprecated in wakunode2 app in favour of the `topic` parameter


I'd not include this in the highlights, but just a single line under a new section Upgrade instructions as in https://github.com/waku-org/nwaku/releases/tag/v0.15.0, which states:

Note that the --topics config item has been deprecated and support will be dropped in future releases. To configure support for multiple pubsub topics, use the new --topic parameter repeatedly.

I usually similarly add a > Note under the release title to bring people's attention to the fact that this release comes with Upgrade Instructions.

jm-clius · 2023-05-16T13:53:05Z

CHANGELOG.md

@@ -1,3 +1,73 @@
+## 2023-05-16 v0.17.0


Suggested change

## 2023-05-16 v0.17.0

## 2023-05-17 v0.17.0

Assuming we're releasing tomorrow...

vpavlin · 2023-05-16T14:19:25Z

but I only see changes included up to 14 April

you are right, super weird

vpavlin · 2023-05-16T14:48:43Z

@jm-clius fixed all the comments apart from merging the related commits - I also re-ran the generation and it seems I got all the commits now. Not sure what happened before.

jm-clius

LGTM, thanks!

jm-clius · 2023-05-16T15:25:49Z

CHANGELOG.md

+
+## Upgrade instructions
+
+* The `--topics` config option has been deprecated to unify the configuration style. It still available in this and will be in next release, but will be removed after that. The new option `--topic` is introduced, which can be use repeatedly to achieve the same behaviour.


Suggested change

* The `--topics` config option has been deprecated to unify the configuration style. It still available in this and will be in next release, but will be removed after that. The new option `--topic` is introduced, which can be use repeatedly to achieve the same behaviour.

* The `--topics` config option has been deprecated to unify the configuration style. It's still available in this and will be in next release, but will be removed after that. The new option `--topic` is introduced, which can be use repeatedly to achieve the same behaviour.

alrevuelta

lgtm thanks!

vpavlin requested review from alrevuelta, rymnc, jm-clius and Ivansete-status May 16, 2023 12:48

vpavlin force-pushed the release/v0.17.0 branch from d53e488 to 06300b6 Compare May 16, 2023 13:33

Ivansete-status approved these changes May 16, 2023

View reviewed changes

jm-clius reviewed May 16, 2023

View reviewed changes

docs(changelog): release v0.17.0

2582a1b

vpavlin force-pushed the release/v0.17.0 branch from 06300b6 to 2582a1b Compare May 16, 2023 14:45

jm-clius approved these changes May 16, 2023

View reviewed changes

alrevuelta approved these changes May 17, 2023

View reviewed changes

rymnc approved these changes May 17, 2023

View reviewed changes

vpavlin merged commit c4370b3 into master May 17, 2023

vpavlin deleted the release/v0.17.0 branch May 17, 2023 13:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(changelog): release notes for v0.17.0 #1735

docs(changelog): release notes for v0.17.0 #1735

vpavlin commented May 16, 2023

Ivansete-status commented May 16, 2023

Ivansete-status left a comment

jm-clius left a comment

jm-clius May 16, 2023

jm-clius May 16, 2023

jm-clius May 16, 2023

jm-clius May 16, 2023

vpavlin May 16, 2023

jm-clius May 16, 2023

jm-clius May 16, 2023

jm-clius May 16, 2023

jm-clius May 16, 2023

jm-clius May 16, 2023

jm-clius May 16, 2023

vpavlin commented May 16, 2023

vpavlin commented May 16, 2023

jm-clius left a comment

jm-clius May 16, 2023

alrevuelta left a comment

	* New Filter protocol implentations
	* New Filter protocol implementation. See [12/WAKU2-FILTER](https://rfc.vac.dev/spec/12/).

	- enr: move waku enr multiaddr to typedrecod and builder extensions ([2ffd2f80](https://github.com/waku-org/nwaku/commit/2ffd2f80))
	- enr: move waku enr multiaddr to typedrecord and builder extensions ([2ffd2f80](https://github.com/waku-org/nwaku/commit/2ffd2f80))

	- connect instead dial relay peers ([#1622](https://github.com/waku-org/nwaku/issues/1622)) ([85f33a8e](https://github.com/waku-org/nwaku/commit/85f33a8e))
	- connect instead of dialing relay peers ([#1622](https://github.com/waku-org/nwaku/issues/1622)) ([85f33a8e](https://github.com/waku-org/nwaku/commit/85f33a8e))


		## Upgrade instructions

		* The `--topics` config option has been deprecated to unify the configuration style. It still available in this and will be in next release, but will be removed after that. The new option `--topic` is introduced, which can be use repeatedly to achieve the same behaviour.

docs(changelog): release notes for v0.17.0 #1735

docs(changelog): release notes for v0.17.0 #1735

Conversation

vpavlin commented May 16, 2023

Description

Ivansete-status commented May 16, 2023

Ivansete-status left a comment

Choose a reason for hiding this comment

jm-clius left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vpavlin commented May 16, 2023

vpavlin commented May 16, 2023

jm-clius left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alrevuelta left a comment

Choose a reason for hiding this comment