Include documentation + committing release branch

.github/workflows/build-and-publish-new-version.yml

@@ -11,6 +11,9 @@ jobs:
   build-and-publish:
     name: Build DeepView.Profile
     runs-on: ubuntu-latest
+    env:
+      CI_COMMIT_AUTHOR: CentML
+      CI_COMMIT_EMAIL: centml-machine-user@users.noreply.github.com
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -32,6 +35,14 @@ jobs:
       - name: Update version number
         run: |
           poetry version ${{ github.event.inputs.tag }}
+
+      - name: Commit updated version number and tag it
+        run: |
+          git config --global user.name "${{ env.CI_COMMIT_AUTHOR }}"
+          git config --global user.email "${{ env.CI_COMMIT_EMAIL }}"
+          git commit -am "Release version ${{ github.event.inputs.tag }}"
+          git push origin release/${{ github.event.inputs.tag }}
+          git tag ${{ github.event.inputs.tag }}
 
       - name: Build Python artifacts
         run: |

README.md

@@ -8,7 +8,6 @@ DeepView.Profile is a tool to profile and debug the training performance of [PyT
 - [Installation](#installation)
 - [Usage example](#getting-started)
 - [Development Environment Setup](#dev-setup)
-- [Release Process](#release-process)
 - [Release History](#release-history)
 - [Meta](#meta)
 - [Contributing](#contributing)
@@ -79,18 +78,6 @@ From the project root, do
 ```zsh
 poetry install
 ```
-<h2 id="release-process">Release Process</h2>
-
-1. Make sure you're on main branch and it is clean
-1. Run [tools/prepare-release.sh](tools/prepare-release.sh) which will:
-    * Increment the version
-    * Create a release branch
-    * Create a release PR
-1. After the PR is merged [build-and-publish-new-version.yml](.github/workflows/build-and-publish-new-version.yml) GitHub action will:
-    * build the Python Wheels
-    * GitHub release
-    * Publish to Test PyPI
-    * Subject to approval publish to PyPI
 
 <h2 id="release-history">Release History</h2>
 

RELEASE.md

@@ -0,0 +1,17 @@
+# How to release a new version of DeepView.Profile
+- Go to Github repo and run the action `build-and-publish-new-version`. You will be prompted to specify the version number.
+
+- This runs a GitHub Action that will take the following steps:
+   1. Fetches the repo and its dependencies
+   2. Creates a release branch
+   3. Updates the version number to the user-specified version by updating the pyproject.toml
+   4. Commits the changes and tag the commit with the version number
+   5. Builds the Python build artifacts
+   7. Publishes a release to Github
+   8. Create a PR to merge back into main
+   9. Publishes to Test PyPI
+   10. Publishes to PyPI
+
+- The action `build-and-publish-new-version` is defined under `.github/workflows/build-and-publish-new-versionyaml`
+
+- This release process follows the release process outlined in [OneFlow](https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow).