Release Process

We try to follow a semantic versioning philosophy while deciding the release version numbers for pcap_to_ditg

The release process for pcap_to_ditg involves the following process:

1. Once the code is ready for release, open setup.py and update the version number (for ex. X.Y.Z)

2. Commit the change with a commit message indicating the release and push it to remote:

git commit -asm "vX.Y.Z"
git push origin master

3. Tag this commit with the version number and push the tag to remote

git tag vX.Y.Z
git push origin tag vX.Y.Z

4. Now, the tag would start to appear on Github. Use the tag to draft a new release. You can use the following command to get the well-formatted list of changes between the latest and the previous tag:

git log --pretty=oneline vU.V.W..vX.Y.Z

This list could be put in the description for the release to communicate the list of changes.

5. Ready the .tar.gz and .whl for publishing the release on pypi

python setup.py sdist bdist_wheel

6. Upload the new release to official pypi repository

python -m twine upload --repository-url https://upload.pypi.org/legacy/ dist/*