Update README.md with release steps

Author: jiripetrlik

.gitignore

@@ -4,3 +4,4 @@ __pycache__/
 .coverage
 Pipfile
 Pipfile.lock
+poetry.lock

README.md

@@ -47,3 +47,29 @@ We use pre-commit to make sure the code is consistently formatted. To make sure
 ### Package Build
 
 To build the python package: `$ poetry build`
+
+## Release Instructions
+
+The following instructions apply when doing release manually.
+
+* Check and update the version in "pyproject.toml" file.
+* Generate new documentation.
+`pdoc --html -o docs src/codeflare_sdk && pushd docs && rm -rf cluster job utils && mv codeflare_sdk/* . && rm -rf codeflare_sdk && popd` (it is possible to install **pdoc** using the following command `poetry install --with docs`)
+* Commit all the changes to the repository.
+* Create Github release (https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release).
+* Build the Python package. `poetry build`
+* If not present already, add the API token to Poetry.
+`poetry config pypi-token.pypi API_TOKEN`
+* Publish the Python package. `poetry publish`
+* Check and update the version in "custom-nb-image/VERSION" file.
+* Update the codeflare-sdk version in "custom-nb-image/Dockerfile".
+* Commit all the changes to the repository.
+* The Github "Image" workflow should take care about the building and publishing of the new image. If not you can
+use the following instructions to build and publish image manually.
+* Change directory to custom-nb-image. `cd custom-nb-image`
+* Get tag `export tag=$(cat VERSION)`
+* Build the Docker image. `docker build -t quay.io/project-codeflare/notebook:${tag} .`
+* Tag the image as latest. `docker tag quay.io/project-codeflare/notebook:${tag} quay.io/project-codeflare/notebook:latest`
+* Login to quay.io. `docker login quay.io`
+* Push the image. `docker push quay.io/project-codeflare/notebook:${tag}`
+* Push the image. `docker push quay.io/project-codeflare/notebook:latest`

pyproject.toml

@@ -26,3 +26,9 @@ rich = "^12.5"
 ray = {version = "2.1.0", extras = ["default"]}
 kubernetes = "26.1.0"
 codeflare-torchx = "0.6.0.dev0"
+
+[tool.poetry.group.docs]
+optional = true
+
+[tool.poetry.group.docs.dependencies]
+pdoc3 = "0.10.0"