docs: release v0.13.0 #1378
Merged
docs: release v0.13.0 #1378
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Jenkins BuildsClick to see older builds (7)
|
alrevuelta
reviewed
Nov 14, 2022
| - Cleaned up compiler warnings on unused imports. | ||
| - Improved exception handling and annotation. | ||
|
|
||
| ### Fixes |
There was a problem hiding this comment.
Personal opinion, but I like having the PR as part of the release notes, specially for the fixes. wdyt?
As a reference I like https://github.com/prysmaticlabs/prysm/releases a lot :)
There was a problem hiding this comment.
Oh, nice reference, thanks. I really like that too - clean and a proper log of everything that was merged. Do you know if they use some kind of auto-generation of release notes from the commit log? I've been considering something like that for nwaku, but am torn between the ease this would provide vs having a curated list of items with impact to user more visible.
There was a problem hiding this comment.
I like having the PR as part of the release notes
I agree! Since automated release notes are not a thing yet and this is a bit manual, I've just added the PRs now to the fixes. 3cf5cb5
There was a problem hiding this comment.
I usually automatically generate the notes with this. You get all changes + linked PR. And then you just have to make some minor modifications to adapt it. The autogenerated text is quite complete. not sure if we must include every single PR, but it's useful as a reference.
What's Changed
- chore(rln-relay): adds Rln-relay testnet2 tutorial by @staheri14 in chore(rln-relay): adds Rln-relay testnet2 tutorial #1232
- chore(rln-relay): disable merkle root validation by @rymnc in chore(rln-relay): disable merkle root validation #1246
- feat(RLN): Add verify against multiple roots by @s1fr0 in feat(RLN): Add verify against multiple roots #1250
- chore(rln-relay): additional logging by @rymnc in chore(rln-relay): additional logging #1243
- chore(rln): update zerokit module by @s1fr0 in chore(rln): update zerokit module #1254
- test(rln-relay): setup heartbeat ws subscription and log when connection drops by @rymnc in test(rln-relay): setup heartbeat ws subscription and log when connection drops #1253
- docs: fix broken Kibana link by @jm-clius in docs: fix broken Kibana link #1255
- fix(rln): change IdCommitment encoding to LE by @s1fr0 in fix(rln): change IdCommitment encoding to LE #1256
- fix(rln): set maxEpochGap as maximum epoch gap by @s1fr0 in fix(rln): set maxEpochGap as maximum epoch gap #1257
- chore(wakucanary): add canary tool by @alrevuelta in chore(wakucanary): add canary tool #1205
- chore(rln-relay): make account address optional by @rymnc in chore(rln-relay): make account address optional #1258
- refactor(rln): display byte arrays in hex as uints and fix Kilic's proofVerify proc by @s1fr0 in refactor(rln): display byte arrays in hex as uints and fix Kilic's proofVerify proc #1259
- chore: move apps and tools to their own directory by @LNSD in chore: move apps and tools to their own directory #1228
- ci: add username and email to build notifications by @jakubgs in ci: add username and email to build notifications #1260
- feat(rln-relay): periodically log metrics by @rymnc in feat(rln-relay): periodically log metrics #1262
- refactor(wakunode2): move config random private key generation to a procedure by @LNSD in refactor(wakunode2): move config random private key generation to a procedure #1273
- refactor(node): split wakunode into waku_node and wakunode2 by @LNSD in refactor(node): split wakunode into waku_node and wakunode2 #1274
- chore(wakucanary): resolve dns by @alrevuelta in chore(wakucanary): resolve dns #1271
- chore(wakunode2): move wakunode2 to apps directory by @LNSD in chore(wakunode2): move wakunode2 to apps directory #1277
- fix: log-level being ignored by @alrevuelta in fix: log-level being ignored #1272
- feat(rln-relay): add metrics dashboard by @rymnc in feat(rln-relay): add metrics dashboard #1275
- fix: store cursors should be exclusive and match a DB item by @jm-clius in fix: store cursors should be exclusive and match a DB item #1263
- chore(store): disable temporarily the store resume flaky test case by @LNSD in chore(store): disable temporarily the store resume flaky test case #1281
- feat(store): add waku store client module by @LNSD in feat(store): add waku store client module #1229
- chore(rln-relay): Changes the test scenario of testnet2 tutorial to one chat user by @staheri14 in chore(rln-relay): Changes the test scenario of testnet2 tutorial to one chat user #1261
- ci: run ci test workflows selectively by @LNSD in ci: run ci test workflows selectively #1284
- feat(chat2): metrics server + metrics logging by @rymnc in feat(chat2): metrics server + metrics logging #1279
- refactor(wakunode2): extract setup proc definitions from main section by @LNSD in refactor(wakunode2): extract setup proc definitions from main section #1286
- chore: extract test procedures and constants into a common module by @LNSD in chore: extract test procedures and constants into a common module #1287
- docs: add docker and quickstart guides by @jm-clius in docs: add docker and quickstart guides #1289
- fix: call runPeerExchangeDiscv5Loop by @kaiserd in fix: call runPeerExchangeDiscv5Loop #1297
- feat(lightpush): add waku lightpush protocol client by @LNSD in feat(lightpush): add waku lightpush protocol client #1295
- ci(jenkins): use MAKEFLAGS and NIMFLAGS pipeline params in build and test stages by @LNSD in ci(jenkins): use MAKEFLAGS and NIMFLAGS pipeline params in build and test stages #1299
- fix(wakunode2): no peer-exchange peer error msg by @kaiserd in fix(wakunode2): no peer-exchange peer error msg #1298
- feat(store): simplify wakunode2 configuration options by @LNSD in feat(store): simplify wakunode2 configuration options #1293
- chore(node): waku node code reorganization by @LNSD in chore(node): waku node code reorganization #1303
- feat(wakunode2): simplify wakunode2 config and decouple peer persistence by @LNSD in feat(wakunode2): simplify wakunode2 config and decouple peer persistence #1300
- chore(rln-relay): removes the Goerli account address config option from the onchain-rln-relay tutorial by @staheri14 in chore(rln-relay): removes the Goerli account address config option from the onchain-rln-relay tutorial #1280
- feat: add keyfile support for RLN credentials secure storage by @s1fr0 in feat: add keyfile support for RLN credentials secure storage #1285
- chore: update submodules and bump Nim to 1.6.6 by @jm-clius in chore: update submodules and bump Nim to 1.6.6 #1307
- feat(testlib): add enable/disable test debug utils by @LNSD in feat(testlib): add enable/disable test debug utils #1315
- feat(wakunode2): add nwaku agent-string to switch by @alrevuelta in feat(wakunode2): add nwaku agent-string to switch #1302
- refactor(node): use lightpush client in waku_node by @LNSD in refactor(node): use lightpush client in waku_node #1308
- chore: remove legacy unused test suite by @LNSD in chore: remove legacy unused test suite #1316
- refactor(node): use store client in waku_node by @LNSD in refactor(node): use store client in waku_node #1309
- chore(common): move sqlite module to common module by @LNSD in chore(common): move sqlite module to common module #1317
- docs(operator-trial): add rln instructions by @rymnc in docs(operator-trial): add rln instructions #1311
- fix(rln-relay): RangeDefect test by @rymnc in fix(rln-relay): RangeDefect test #1318
- feat(rln-relay): track last seen event by @rymnc in feat(rln-relay): track last seen event #1296
- refactor(peer-exchange): move peer management to waku_node module by @LNSD in refactor(peer-exchange): move peer management to waku_node module #1320
- feat(filter): split waku filter protocol into server and client by @LNSD in feat(filter): split waku filter protocol into server and client #1319
- fix: replace TaintedString type deprecated in nim 1.5 by @LNSD in fix: replace TaintedString type deprecated in nim 1.5 #1326
- fix: replace nim's std/nre with nim-regex library by @LNSD in fix: replace nim's std/nre with nim-regex library #1327
- refactor(sqlite): move migrations logic to sqlite common module by @LNSD in refactor(sqlite): move migrations logic to sqlite common module #1325
- fix(wakunode2): fix message retention policy config validation regex by @LNSD in fix(wakunode2): fix message retention policy config validation regex #1328
- refactor(wakunode2): move configuration load logic to config module by @LNSD in refactor(wakunode2): move configuration load logic to config module #1329
- chore: randomize waku tcp ports in tests by @LNSD in chore: randomize waku tcp ports in tests #1336
- chore: make log topics consistent with nim-chronicles style by @LNSD in chore: make log topics consistent with nim-chronicles style #1334
- chore(migrations): move migration scripts to project root by @LNSD in chore(migrations): move migration scripts to project root #1330
- feat(testlib): mark commented test cases as skipped by @LNSD in feat(testlib): mark commented test cases as skipped #1337
- feat(wakunode2): support configuration via environment variables by @LNSD in feat(wakunode2): support configuration via environment variables #1331
- chore(rln-relay): remove all raises and replace with Result types by @rymnc in chore(rln-relay): remove all raises and replace with Result types #1321
- refactor(peer_manager): move peer_store under peer_manager module by @LNSD in refactor(peer_manager): move peer_store under peer_manager module #1339
- chore: remove unused imports by @LNSD in chore: remove unused imports #1340
- chore: update push raises pragma according to nim 1.6 by @LNSD in chore: update push raises pragma according to nim 1.6 #1341
- ci: fix path to migrations in Dockerfile by @jakubgs in ci: fix path to migrations in Dockerfile #1343
- chore(examples): add pubsub example with production env by @alrevuelta in chore(examples): add pubsub example with production env #1333
- refactor(message_store): move message_store to node module by @LNSD in refactor(message_store): move message_store to node module #1342
- chore(wakucanary): remove port hardcoding + add cli config by @alrevuelta in chore(wakucanary): remove port hardcoding + add cli config #1345
- chore: build rln dependecies only when building v2 by @LNSD in chore: build rln dependecies only when building v2 #1344
- chore: rename protocols rpc_codec procs from init to decode by @LNSD in chore: rename protocols rpc_codec procs from init to decode #1346
- fix(rln-relay): remove dependency on applications' configuration by @LNSD in fix(rln-relay): remove dependency on applications' configuration #1351
- chore(rln): update ganache by @s1fr0 in chore(rln): update ganache #1347
- refactor(queue_store): rename queue_store module and simplify api by @LNSD in refactor(queue_store): rename queue_store module and simplify api #1348
- docs: extend docs with the different node configuration mechanisms by @LNSD in docs: extend docs with the different node configuration mechanisms #1355
- refactor: unify pubsub topic type and default value by @LNSD in refactor: unify pubsub topic type and default value #1352
- refactor: continue pubsub/content types started in refactor: unify pubsub topic type and default value #1352 by @alrevuelta in refactor: continue pubsub/content types started in #1352 #1362
- refactor(store): decouple waku store public api types from rpc types by @LNSD in refactor(store): decouple waku store public api types from rpc types #1350
- refactor(rln): remove kilic lib by @s1fr0 in refactor(rln): remove kilic lib #1365
- chore(networkmonitor): tool to discover and provide metrics on peers by @alrevuelta in chore(networkmonitor): tool to discover and provide metrics on peers #1290
- chore: upgrade nim-stew to latest version by @LNSD in chore: upgrade nim-stew to latest version #1366
- docs: extend waku store config tutorial of the operator docs by @LNSD in docs: extend waku store config tutorial of the operator docs #1359
- feat(rln-relay): process blocks atomically by @rymnc in feat(rln-relay): process blocks atomically #1349
- chore(networkmonitor): add metric listing content topics + messages by @alrevuelta in chore(networkmonitor): add metric listing content topics + messages #1335
- chore: disable store protocol by default by @jm-clius in chore: disable store protocol by default #1374
- fix(rln-relay): feature guard by @rymnc in fix(rln-relay): feature guard #1373
New Contributors
- @alrevuelta made their first contribution in chore(wakucanary): add canary tool #1205
Full Changelog: v0.12.0...v0.13.0
There was a problem hiding this comment.
Indeed! Let's consider for next release. May want to introduce more sections and remove some confusing repeated items, but I like the approach.
s1fr0
reviewed
Nov 14, 2022
s1fr0
reviewed
Nov 14, 2022
s1fr0
reviewed
Nov 14, 2022
s1fr0
reviewed
Nov 14, 2022
s1fr0
approved these changes
Nov 14, 2022
alrevuelta
approved these changes
Nov 14, 2022
There was a problem hiding this comment.
lgtm! Added a minor comment in case autogenerated notes is relevant for next releases.
jm-clius
force-pushed
the
release/v0.13.0
branch
from
3a06f43
to
86f2183
Compare
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds the release notes for Release v0.13.0
I believe everything necessary for the release has been merged already.
For the items you were responsible for, please check: