Create GitHub action to automate release

Author: jiripetrlik

.github/workflows/image.yml

@@ -0,0 +1,81 @@
+name: Release
+
+on:
+    workflow_dispatch:
+        inputs:
+            release-version:
+              type: string
+              required: true
+              description: 'Version number (for example: 0.1.0)'
+            is-latest:
+              description: 'Select if the built image should be tagged as latest'
+              required: true
+              type: boolean
+            quay-organization:
+              description: 'Quay organization used to push the built images to'
+              required: true
+              default: 'project-codeflare'
+            python_version:
+              type: string
+              default: "3.8"
+              required: true
+            poetry_version:
+              type: string
+              default: "1.5.1"
+              required: true
+
+jobs:
+    release:
+        runs-on: ubuntu-latest
+        permissions:
+            contents: write
+        steps:
+            - name: Checkout the repository
+              uses: actions/checkout@v3
+            - name: Install Python
+              uses: actions/setup-python@v4
+              with:
+                python-version: ${{ github.event.inputs.python_version }}
+            - name: Install Poetry
+              uses: abatilo/actions-poetry@v2
+              with:
+                poetry-version: ${{ github.event.inputs.poetry_version }}
+            - name: Change version in pyproject.toml
+              run: poetry version "${{ github.event.inputs.release-version }}"
+            - name: Run poetry install
+              run: poetry install --with docs
+            - name: Run poetry build
+              run: poetry build
+            - name: Create new documentation
+              run: poetry run pdoc --html -o docs src/codeflare_sdk && pushd docs && rm -rf cluster job utils && mv codeflare_sdk/* . && rm -rf codeflare_sdk && popd
+            - name: Set Pypi token
+              run: poetry config pypi-token.pypi ${{ secrets.PYPI_TOKEN }}
+            - name: Publish new release to Pypi repository
+              run: poetry publish
+
+            - name: Commit changes in docs
+              uses: stefanzweifel/git-auto-commit-action@v4
+              with:
+                file_pattern: 'docs'
+                commit_message: "Changes in docs for release: v${{ github.event.inputs.release-version }}"
+            - name: Create Github release
+              uses: ncipollo/release-action@v1
+              with:
+                  tag: "v${{ github.event.inputs.release-version }}"
+
+            - name: Image Build
+              run: |
+                cd custom-nb-image
+                docker build --build-arg SDK_VERSION="${{ github.event.inputs.release-version }}" -t quay.io/${{ github.event.inputs.quay-organization }}/notebook:v${{ github.event.inputs.release-version }} .
+                docker tag quay.io/${{ github.event.inputs.quay-organization }}/notebook:v${{ github.event.inputs.release-version }} quay.io/${{ github.event.inputs.quay-organization }}/notebook:latest
+            - name: Login to Quay.io
+              uses: docker/login-action@v2
+              with:
+                registry: quay.io
+                username: ${{ secrets.QUAY_ID }}
+                password: ${{ secrets.QUAY_TOKEN }}
+            - name: Image Push
+              run: docker push quay.io/${{ github.event.inputs.quay-organization }}/notebook:v${{ github.event.inputs.release-version }}
+            - name: Image Push Latest
+              if: ${{ inputs.is-latest }}
+              run: docker push quay.io/${{ github.event.inputs.quay-organization }}/notebook:latest

.github/workflows/release.yaml

@@ -51,7 +51,14 @@ To build the python package: `$ poetry build`
 
 ## Release Instructions
 
-The following instructions apply when doing release manually.
+
+### Automated Releases
+
+It is possible to use the Release Github workflow to do the release. This is generally the process we follow for releases
+
+### Manual Releases
+
+The following instructions apply when doing release manually. This may be required in instances where the automation is failing.
 
 * Check and update the version in "pyproject.toml" file.
 * Generate new documentation.
@@ -62,14 +69,9 @@ The following instructions apply when doing release manually.
 * 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} .`
+* Set tag `export tag=TAG`
+* Build the Docker image. `docker build --build-arg SDK_VERSION=<version> -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}`

README.md

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "codeflare-sdk"
-version = "0.4.5"
+version = "0.0.0-dev"
 description = "Python SDK for codeflare client"
 
 license = "Apache-2.0"