From 2d6002f5675802fdd97a2c3bf1379bf5d0cfadd0 Mon Sep 17 00:00:00 2001 From: Anupam Bhatnagar Date: Thu, 5 Jan 2023 22:34:36 -0800 Subject: [PATCH 1/3] adding new files for release --- MANIFEST.in | 2 ++ RELEASE.md | 13 +++++++++++++ 2 files changed, 15 insertions(+) create mode 100644 MANIFEST.in create mode 100644 RELEASE.md 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..459b7c2 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,13 @@ +# Steps to make a release +1. Pull the most recent tags: `git fetch 1.1.all 1.1.tags`. +1. Create a new branch from main, say `release1.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 1.1.upgrade twine build`. +1. Build the source distribution and wheel files: `python3 1.m build`. +1. Verify the new pacakage 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. From abe3225a3c52e3e31480a201e0bccc206b3b7801 Mon Sep 17 00:00:00 2001 From: Anupam Bhatnagar Date: Thu, 5 Jan 2023 22:39:33 -0800 Subject: [PATCH 2/3] fix typos --- RELEASE.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 459b7c2..5509048 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,9 +1,9 @@ # Steps to make a release -1. Pull the most recent tags: `git fetch 1.1.all 1.1.tags`. -1. Create a new branch from main, say `release1.vX.Y.Z` where X.Y.Z is the new release number. +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 1.1.upgrade twine build`. -1. Build the source distribution and wheel files: `python3 1.m build`. +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 pacakage 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__)'` From a860fc4fd95b3ba3039db199f037124fd0745f67 Mon Sep 17 00:00:00 2001 From: Anupam Bhatnagar Date: Fri, 6 Jan 2023 12:23:17 -0800 Subject: [PATCH 3/3] fix typo --- RELEASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASE.md b/RELEASE.md index 5509048..e6f4ac7 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -4,7 +4,7 @@ 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 pacakage can be installed using pip: +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.