Skip to content

Commit 9798db3

Browse files
committed
fix towncrier config and correct links in release_notes
1 parent 0430ad3 commit 9798db3

File tree

4 files changed

+48
-47
lines changed

4 files changed

+48
-47
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ ifndef bump
124124
endif
125125

126126
check-git:
127-
# require that upstream is configured for ethereum/py-libp2p
127+
# require that upstream is configured for libp2p/py-libp2p
128128
@if ! git remote -v | grep "upstream[[:space:]][email protected]:libp2p/py-libp2p.git (push)\|upstream[[:space:]]https://github.com/libp2p/py-libp2p (push)"; then \
129129
echo "Error: You must have a remote named 'upstream' that points to 'py-libp2p'"; \
130130
exit 1; \

docs/release_notes.rst

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,21 @@ py-libp2p v0.2.5 (2025-04-14)
99
Bugfixes
1010
~~~~~~~~
1111

12-
- Fixed flaky test_simple_last_seen_cache by adding a retry loop for reliable expiry detection across platforms. (`#558 <https://github.com/ethereum/py-libp2p/issues/558>`__)
12+
- Fixed flaky test_simple_last_seen_cache by adding a retry loop for reliable expiry detection across platforms. (`#558 <https://github.com/libp2p/py-libp2p/issues/558>`__)
1313

1414

1515
Improved Documentation
1616
~~~~~~~~~~~~~~~~~~~~~~
1717

18-
- Added install and getting started documentation. (`#559 <https://github.com/ethereum/py-libp2p/issues/559>`__)
18+
- Added install and getting started documentation. (`#559 <https://github.com/libp2p/py-libp2p/issues/559>`__)
1919

2020

2121
Features
2222
~~~~~~~~
2323

24-
- Added a ``pub-sub`` example having ``gossipsub`` as the router to demonstrate how to use the pub-sub module in py-libp2p. (`#515 <https://github.com/ethereum/py-libp2p/issues/515>`__)
25-
- Added documentation on how to add examples to the libp2p package. (`#550 <https://github.com/ethereum/py-libp2p/issues/550>`__)
26-
- Added Windows-specific development setup instructions to `docs/contributing.rst`. (`#559 <https://github.com/ethereum/py-libp2p/issues/559>`__)
24+
- Added a ``pub-sub`` example having ``gossipsub`` as the router to demonstrate how to use the pub-sub module in py-libp2p. (`#515 <https://github.com/libp2p/py-libp2p/issues/515>`__)
25+
- Added documentation on how to add examples to the libp2p package. (`#550 <https://github.com/libp2p/py-libp2p/issues/550>`__)
26+
- Added Windows-specific development setup instructions to `docs/contributing.rst`. (`#559 <https://github.com/libp2p/py-libp2p/issues/559>`__)
2727

2828

2929
py-libp2p v0.2.4 (2025-03-27)
@@ -32,7 +32,7 @@ py-libp2p v0.2.4 (2025-03-27)
3232
Bugfixes
3333
~~~~~~~~
3434

35-
- Added Windows compatibility by using coincurve instead of fastecdsa on Windows platforms (`#507 <https://github.com/ethereum/py-libp2p/issues/507>`__)
35+
- Added Windows compatibility by using coincurve instead of fastecdsa on Windows platforms (`#507 <https://github.com/libp2p/py-libp2p/issues/507>`__)
3636

3737

3838
py-libp2p v0.2.3 (2025-03-27)
@@ -41,36 +41,36 @@ py-libp2p v0.2.3 (2025-03-27)
4141
Bugfixes
4242
~~~~~~~~
4343

44-
- Fixed import path in the examples to use updated `net_stream` module path, resolving ModuleNotFoundError when running the examples. (`#513 <https://github.com/ethereum/py-libp2p/issues/513>`__)
44+
- Fixed import path in the examples to use updated `net_stream` module path, resolving ModuleNotFoundError when running the examples. (`#513 <https://github.com/libp2p/py-libp2p/issues/513>`__)
4545

4646

4747
Improved Documentation
4848
~~~~~~~~~~~~~~~~~~~~~~
4949

50-
- Updates ``Feature Breakdown`` in ``README`` to more closely match the list of standard modules. (`#498 <https://github.com/ethereum/py-libp2p/issues/498>`__)
51-
- Adds detailed Sphinx-style docstrings to ``abc.py``. (`#535 <https://github.com/ethereum/py-libp2p/issues/535>`__)
50+
- Updates ``Feature Breakdown`` in ``README`` to more closely match the list of standard modules. (`#498 <https://github.com/libp2p/py-libp2p/issues/498>`__)
51+
- Adds detailed Sphinx-style docstrings to ``abc.py``. (`#535 <https://github.com/libp2p/py-libp2p/issues/535>`__)
5252

5353

5454
Features
5555
~~~~~~~~
5656

57-
- Improved the implementation of the identify protocol and enhanced test coverage to ensure proper functionality and network layer address delegation. (`#358 <https://github.com/ethereum/py-libp2p/issues/358>`__)
58-
- Adds the ability to check connection status of a peer in the peerstore. (`#420 <https://github.com/ethereum/py-libp2p/issues/420>`__)
59-
- implemented ``timed_cache`` module which will allow to implement ``seen_ttl`` configurable param for pubsub and protocols extending it. (`#518 <https://github.com/ethereum/py-libp2p/issues/518>`__)
57+
- Improved the implementation of the identify protocol and enhanced test coverage to ensure proper functionality and network layer address delegation. (`#358 <https://github.com/libp2p/py-libp2p/issues/358>`__)
58+
- Adds the ability to check connection status of a peer in the peerstore. (`#420 <https://github.com/libp2p/py-libp2p/issues/420>`__)
59+
- implemented ``timed_cache`` module which will allow to implement ``seen_ttl`` configurable param for pubsub and protocols extending it. (`#518 <https://github.com/libp2p/py-libp2p/issues/518>`__)
6060
- Added a maximum RSA key size limit of 4096 bits to prevent resource exhaustion attacks.Consolidated validation logic to use a single error message source and
61-
added tests to catch invalid key sizes (including negative values). (`#523 <https://github.com/ethereum/py-libp2p/issues/523>`__)
62-
- Added automated testing of ``demo`` applications as part of CI to prevent demos from breaking silently. Tests are located in `tests/core/examples/test_examples.py`. (`#524 <https://github.com/ethereum/py-libp2p/issues/524>`__)
63-
- Added an example implementation of the identify protocol to demonstrate its usage and help users understand how to properly integrate it into their libp2p applications. (`#536 <https://github.com/ethereum/py-libp2p/issues/536>`__)
61+
added tests to catch invalid key sizes (including negative values). (`#523 <https://github.com/libp2p/py-libp2p/issues/523>`__)
62+
- Added automated testing of ``demo`` applications as part of CI to prevent demos from breaking silently. Tests are located in `tests/core/examples/test_examples.py`. (`#524 <https://github.com/libp2p/py-libp2p/issues/524>`__)
63+
- Added an example implementation of the identify protocol to demonstrate its usage and help users understand how to properly integrate it into their libp2p applications. (`#536 <https://github.com/libp2p/py-libp2p/issues/536>`__)
6464

6565

6666
Internal Changes - for py-libp2p Contributors
6767
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6868

69-
- moved all interfaces to ``libp2p.abc`` along with all libp2p custom types to ``libp2p.custom_types``. (`#228 <https://github.com/ethereum/py-libp2p/issues/228>`__)
70-
- moved ``libp2p/tools/factories`` to ``tests``. (`#503 <https://github.com/ethereum/py-libp2p/issues/503>`__)
71-
- Fixes broken CI lint run, bumps ``pre-commit-hooks`` version to ``5.0.0`` and ``mdformat`` to ``0.7.22``. (`#522 <https://github.com/ethereum/py-libp2p/issues/522>`__)
72-
- Rebuilds protobufs with ``protoc v30.1``. (`#542 <https://github.com/ethereum/py-libp2p/issues/542>`__)
73-
- Moves ``pubsub`` testing tools from ``libp2p.tools`` and ``factories`` from ``tests`` to ``tests.utils``. (`#543 <https://github.com/ethereum/py-libp2p/issues/543>`__)
69+
- moved all interfaces to ``libp2p.abc`` along with all libp2p custom types to ``libp2p.custom_types``. (`#228 <https://github.com/libp2p/py-libp2p/issues/228>`__)
70+
- moved ``libp2p/tools/factories`` to ``tests``. (`#503 <https://github.com/libp2p/py-libp2p/issues/503>`__)
71+
- Fixes broken CI lint run, bumps ``pre-commit-hooks`` version to ``5.0.0`` and ``mdformat`` to ``0.7.22``. (`#522 <https://github.com/libp2p/py-libp2p/issues/522>`__)
72+
- Rebuilds protobufs with ``protoc v30.1``. (`#542 <https://github.com/libp2p/py-libp2p/issues/542>`__)
73+
- Moves ``pubsub`` testing tools from ``libp2p.tools`` and ``factories`` from ``tests`` to ``tests.utils``. (`#543 <https://github.com/libp2p/py-libp2p/issues/543>`__)
7474

7575

7676
py-libp2p v0.2.2 (2025-02-20)
@@ -79,21 +79,21 @@ py-libp2p v0.2.2 (2025-02-20)
7979
Bugfixes
8080
~~~~~~~~
8181

82-
- - This fix issue #492 adding a missing break statement that lowers GIL usage from 99% to 0%-2%. (`#492 <https://github.com/ethereum/py-libp2p/issues/492>`__)
82+
- - This fix issue #492 adding a missing break statement that lowers GIL usage from 99% to 0%-2%. (`#492 <https://github.com/libp2p/py-libp2p/issues/492>`__)
8383

8484

8585
Features
8686
~~~~~~~~
8787

88-
- Create entry points for demos to be run directly from installed package (`#490 <https://github.com/ethereum/py-libp2p/issues/490>`__)
89-
- Merge template, adding python 3.13 to CI checks. (`#496 <https://github.com/ethereum/py-libp2p/issues/496>`__)
88+
- Create entry points for demos to be run directly from installed package (`#490 <https://github.com/libp2p/py-libp2p/issues/490>`__)
89+
- Merge template, adding python 3.13 to CI checks. (`#496 <https://github.com/libp2p/py-libp2p/issues/496>`__)
9090

9191

9292
Internal Changes - for py-libp2p Contributors
9393
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9494

95-
- Drop CI runs for python 3.8, run ``pyupgrade`` to bring code up to python 3.9. (`#497 <https://github.com/ethereum/py-libp2p/issues/497>`__)
96-
- Rename ``typing.py`` to ``custom_types.py`` for clarity. (`#500 <https://github.com/ethereum/py-libp2p/issues/500>`__)
95+
- Drop CI runs for python 3.8, run ``pyupgrade`` to bring code up to python 3.9. (`#497 <https://github.com/libp2p/py-libp2p/issues/497>`__)
96+
- Rename ``typing.py`` to ``custom_types.py`` for clarity. (`#500 <https://github.com/libp2p/py-libp2p/issues/500>`__)
9797

9898

9999
py-libp2p v0.2.1 (2024-12-20)
@@ -102,28 +102,28 @@ py-libp2p v0.2.1 (2024-12-20)
102102
Bugfixes
103103
~~~~~~~~
104104

105-
- Added missing check to reject messages claiming to be from ourselves but not locally published in pubsub's ``push_msg`` function (`#413 <https://github.com/ethereum/py-libp2p/issues/413>`__)
106-
- Added missing check in ``add_addrs`` function for duplicate addresses in ``peerdata`` (`#485 <https://github.com/ethereum/py-libp2p/issues/485>`__)
105+
- Added missing check to reject messages claiming to be from ourselves but not locally published in pubsub's ``push_msg`` function (`#413 <https://github.com/libp2p/py-libp2p/issues/413>`__)
106+
- Added missing check in ``add_addrs`` function for duplicate addresses in ``peerdata`` (`#485 <https://github.com/libp2p/py-libp2p/issues/485>`__)
107107

108108

109109
Improved Documentation
110110
~~~~~~~~~~~~~~~~~~~~~~
111111

112-
- added missing details of params in ``IPubsubRouter`` (`#486 <https://github.com/ethereum/py-libp2p/issues/486>`__)
112+
- added missing details of params in ``IPubsubRouter`` (`#486 <https://github.com/libp2p/py-libp2p/issues/486>`__)
113113

114114

115115
Features
116116
~~~~~~~~
117117

118-
- Added ``PingService`` class in ``host/ping.py`` which can be used to initiate ping requests to peers and added tests for the same (`#344 <https://github.com/ethereum/py-libp2p/issues/344>`__)
119-
- Added ``get_connected_peers`` method in class ``IHost`` which can be used to get a list of peer ids of currently connected peers (`#419 <https://github.com/ethereum/py-libp2p/issues/419>`__)
118+
- Added ``PingService`` class in ``host/ping.py`` which can be used to initiate ping requests to peers and added tests for the same (`#344 <https://github.com/libp2p/py-libp2p/issues/344>`__)
119+
- Added ``get_connected_peers`` method in class ``IHost`` which can be used to get a list of peer ids of currently connected peers (`#419 <https://github.com/libp2p/py-libp2p/issues/419>`__)
120120

121121

122122
Internal Changes - for py-libp2p Contributors
123123
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
124124

125-
- Update ``sphinx_rtd_theme`` options and drop pdf build of docs (`#481 <https://github.com/ethereum/py-libp2p/issues/481>`__)
126-
- Update ``trio`` package version dependency (`#482 <https://github.com/ethereum/py-libp2p/issues/482>`__)
125+
- Update ``sphinx_rtd_theme`` options and drop pdf build of docs (`#481 <https://github.com/libp2p/py-libp2p/issues/481>`__)
126+
- Update ``trio`` package version dependency (`#482 <https://github.com/libp2p/py-libp2p/issues/482>`__)
127127

128128

129129
py-libp2p v0.2.0 (2024-07-09)
@@ -132,38 +132,38 @@ py-libp2p v0.2.0 (2024-07-09)
132132
Breaking Changes
133133
~~~~~~~~~~~~~~~~
134134

135-
- Drop support for ``python<3.8`` (`#447 <https://github.com/ethereum/py-libp2p/issues/447>`__)
136-
- Drop dep for unmaintained ``async-service`` and copy relevant functions into a local tool of the same name (`#467 <https://github.com/ethereum/py-libp2p/issues/467>`__)
135+
- Drop support for ``python<3.8`` (`#447 <https://github.com/libp2p/py-libp2p/issues/447>`__)
136+
- Drop dep for unmaintained ``async-service`` and copy relevant functions into a local tool of the same name (`#467 <https://github.com/libp2p/py-libp2p/issues/467>`__)
137137

138138

139139
Improved Documentation
140140
~~~~~~~~~~~~~~~~~~~~~~
141141

142-
- Move contributing and history info from README to docs (`#454 <https://github.com/ethereum/py-libp2p/issues/454>`__)
143-
- Display example usage and full code in docs (`#466 <https://github.com/ethereum/py-libp2p/issues/466>`__)
142+
- Move contributing and history info from README to docs (`#454 <https://github.com/libp2p/py-libp2p/issues/454>`__)
143+
- Display example usage and full code in docs (`#466 <https://github.com/libp2p/py-libp2p/issues/466>`__)
144144

145145

146146
Features
147147
~~~~~~~~
148148

149-
- Add basic support for ``python3.8, 3.9, 3.10, 3.11, 3.12`` (`#447 <https://github.com/ethereum/py-libp2p/issues/447>`__)
149+
- Add basic support for ``python3.8, 3.9, 3.10, 3.11, 3.12`` (`#447 <https://github.com/libp2p/py-libp2p/issues/447>`__)
150150

151151

152152
Internal Changes - for py-libp2p Contributors
153153
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
154154

155-
- Merge updates from ethereum python project template, including using ``pre-commit`` for linting, change name of ``master`` branch to ``main``, lots of linting changes (`#447 <https://github.com/ethereum/py-libp2p/issues/447>`__)
156-
- Fix docs CI, drop ``bumpversion`` for ``bump-my-version``, reorg tests (`#454 <https://github.com/ethereum/py-libp2p/issues/454>`__)
157-
- Turn ``mypy`` checks on and remove ``async_generator`` dependency (`#464 <https://github.com/ethereum/py-libp2p/issues/464>`__)
158-
- Convert ``KeyType`` enum to use ``protobuf.KeyType`` options rather than ints, rebuild protobufs to include ``ECC_P256`` (`#465 <https://github.com/ethereum/py-libp2p/issues/465>`__)
159-
- Bump to ``mypy==1.10.0``, run ``pre-commit`` local hook instead of ``mirrors-mypy`` (`#472 <https://github.com/ethereum/py-libp2p/issues/472>`__)
160-
- Bump ``protobufs`` dep to ``>=5.27.2`` and rebuild protobuf definition with ``protoc==27.2`` (`#473 <https://github.com/ethereum/py-libp2p/issues/473>`__)
155+
- Merge updates from ethereum python project template, including using ``pre-commit`` for linting, change name of ``master`` branch to ``main``, lots of linting changes (`#447 <https://github.com/libp2p/py-libp2p/issues/447>`__)
156+
- Fix docs CI, drop ``bumpversion`` for ``bump-my-version``, reorg tests (`#454 <https://github.com/libp2p/py-libp2p/issues/454>`__)
157+
- Turn ``mypy`` checks on and remove ``async_generator`` dependency (`#464 <https://github.com/libp2p/py-libp2p/issues/464>`__)
158+
- Convert ``KeyType`` enum to use ``protobuf.KeyType`` options rather than ints, rebuild protobufs to include ``ECC_P256`` (`#465 <https://github.com/libp2p/py-libp2p/issues/465>`__)
159+
- Bump to ``mypy==1.10.0``, run ``pre-commit`` local hook instead of ``mirrors-mypy`` (`#472 <https://github.com/libp2p/py-libp2p/issues/472>`__)
160+
- Bump ``protobufs`` dep to ``>=5.27.2`` and rebuild protobuf definition with ``protoc==27.2`` (`#473 <https://github.com/libp2p/py-libp2p/issues/473>`__)
161161

162162

163163
Removals
164164
~~~~~~~~
165165

166-
- Drop ``async-exit-stack`` dep, as of py37 can import ``AsyncExitStack`` from contextlib, also open ``pynacl`` dep to bottom pin only (`#468 <https://github.com/ethereum/py-libp2p/issues/468>`__)
166+
- Drop ``async-exit-stack`` dep, as of py37 can import ``AsyncExitStack`` from contextlib, also open ``pynacl`` dep to bottom pin only (`#468 <https://github.com/libp2p/py-libp2p/issues/468>`__)
167167

168168

169169
libp2p v0.1.5 (2020-03-25)

newsfragments/561.feature.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Added AutoNAT protocol

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,10 @@ markers = ["slow: mark test as slow"]
7373
xfail_strict = true
7474

7575
[tool.towncrier]
76-
# Read https://github.com/ethereum/py-libp2p/blob/main/newsfragments/README.md for instructions
76+
# Read https://github.com/libp2p/py-libp2p/blob/main/newsfragments/README.md for instructions
7777
directory = "newsfragments"
7878
filename = "docs/release_notes.rst"
79-
issue_format = "`#{issue} <https://github.com/ethereum/py-libp2p/issues/{issue}>`__"
79+
issue_format = "`#{issue} <https://github.com/libp2p/py-libp2p/issues/{issue}>`__"
8080
package = "libp2p"
8181
title_format = "py-libp2p v{version} ({project_date})"
8282
underlines = ["-", "~", "^"]

0 commit comments

Comments
 (0)