Skip to content

Commit ac3d5bb

Browse files
authored
Improve release doc (#4369)
1 parent 0ebe567 commit ac3d5bb

File tree

2 files changed

+17
-11
lines changed

2 files changed

+17
-11
lines changed

doc/scapy/development.rst

+12-7
Original file line numberDiff line numberDiff line change
@@ -293,23 +293,28 @@ signing a commit, the maintainer that wishes to create a release must:
293293
Taking v2.4.3 as an example, the following commands can be used to sign and
294294
publish the release::
295295

296-
git tag -s v2.4.3 -m "Release 2.4.3"
297-
git tag v2.4.3 -v
298-
git push --tags
296+
$ git tag -s v2.4.3 -m "Release 2.4.3"
297+
$ git tag v2.4.3 -v
298+
$ git push --tags
299299

300300
Release Candidates (RC) could also be done. For example, the first RC will be
301301
tagged v2.4.3rc1 and the message ``2.4.3 Release Candidate #1``.
302302

303+
.. note::
304+
To add a signing key, configure to use a SSH one, then register it via::
305+
$ git config --global gpg.format ssh
306+
$ git config --global user.signingkey ~/.ssh/examplekey.pub
307+
303308
Prior to uploading the release to PyPi, the mail address of the maintainer
304309
performing the release must be added next to his name in ``pyproject.toml``.
305310
See `this <https://packaging.python.org/en/latest/specifications/declaring-project-metadata/#authors-maintainers>`_ for details.
306311

307312
The following commands can then be used::
308313

309-
pip install --upgrade build
310-
python -m build
311-
twine check dist/*
312-
twine upload dist/*
314+
$ pip install --upgrade build
315+
$ SCAPY_VERSION=2.6.0rc1 python -m build
316+
$ twine check dist/*
317+
$ twine upload dist/*
313318

314319
.. warning::
315320
Make sure that you don't have left-overs in your ``dist/`` folder ! There should only be the source and the wheel for the package.

pyproject.toml

+5-4
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,11 @@ classifiers = [
4141
]
4242

4343
[project.urls]
44-
homepage = "https://scapy.net"
45-
documentation = "https://scapy.readthedocs.io"
46-
repository = "https://github.com/secdev/scapy"
47-
changelog = "https://github.com/secdev/scapy/releases"
44+
Homepage = "https://scapy.net"
45+
Download = "https://github.com/secdev/scapy/tarball/master"
46+
Documentation = "https://scapy.readthedocs.io"
47+
"Source Code" = "https://github.com/secdev/scapy"
48+
Changelog = "https://github.com/secdev/scapy/releases"
4849

4950
[project.scripts]
5051
scapy = "scapy.main:interact"

0 commit comments

Comments
 (0)