-
Notifications
You must be signed in to change notification settings - Fork 47
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #13 from facebookresearch/release-utils
adding new files for release
- Loading branch information
Showing
2 changed files
with
15 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
include requirements.txt | ||
include docs/conf.py |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |