diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..637ff9b --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,2 @@ +include requirements.txt +include docs/conf.py diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..e6f4ac7 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,13 @@ +# Steps to make a release +1. Pull the most recent tags: `git fetch --all --tags`. +1. Create a new branch from main, say `release-vX.Y.Z` where X.Y.Z is the new release number. +1. Bump the version in `hta/version.py`. Versions must adhere to [Semantic Versioning](https://semver.org/). +1. Install `twine` and `build` locally: `pip install --upgrade twine build`. +1. Build the source distribution and wheel files: `python3 -m build`. +1. Verify the new package can be installed using pip: + 1. In a new conda environment execute: `pip install dist/HolisticTraceAnalysis1.X.Y.Z.tar.gz` + 1. Verify version of the new package: `python -c 'import hta; print(hta.__version__)'` +1. Merge the release branch into main through a PR. +1. Upload the release to PyPI: `twine upload dist/*` (requires PyPI account). +1. Create a new release on [this + page](https://github.com/facebookresearch/HolisticTraceAnalysis/releases) on Github.