Skip to content

Commit

Permalink
Merge pull request #13 from facebookresearch/release-utils
Browse files Browse the repository at this point in the history
adding new files for release
  • Loading branch information
anupambhatnagar authored Jan 6, 2023
2 parents a12e7c8 + a860fc4 commit 8051faf
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
2 changes: 2 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
include requirements.txt
include docs/conf.py
13 changes: 13 additions & 0 deletions RELEASE.md
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.

0 comments on commit 8051faf

Please sign in to comment.