Merge pull request #861 from ljubon/release-review

Release review

Author: devstein

.bumpversion.cfg

@@ -0,0 +1,18 @@
+[bumpversion]
+current_version = 0.21.0
+commit = True
+tag = True
+tag_name = {new_version}
+message = "Bump version: {current_version} → {new_version}"
+
+[bumpversion:file:sparkmagic/sparkmagic/__init__.py]
+search = __version__ = "{current_version}"
+replace = __version__ = "{new_version}"
+
+[bumpversion:file:autovizwidget/autovizwidget/__init__.py]
+search = __version__ = "{current_version}"
+replace = __version__ = "{new_version}"
+
+[bumpversion:file:hdijupyterutils/hdijupyterutils/__init__.py]
+search = __version__ = "{current_version}"
+replace = __version__ = "{new_version}"

.github/workflows/release.yml

@@ -0,0 +1,55 @@
+---
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      type:
+        type: choice
+        description: Select type of bump version
+        # https://github.com/jaumann/github-bumpversion-action/tree/v0.0.7/?tab=readme-ov-file#bumping
+        options:
+          - major
+          - minor
+          - patch
+        default: 'patch'
+jobs:
+  release:
+    # Do not run this job for pull requests where both branches are from the same repo.
+    # Jobs that depend on this one will be skipped too.
+    # This prevents duplicate CI runs for our own pull requests, whilst preserving the ability to
+    # run the CI for each branch push to a fork, and for each pull request originating from a fork.
+    if: github.event_name == 'workflow_dispatch' || github.event.pull_request.head.repo.id != github.event.pull_request.base.repo.id
+    permissions:
+      contents: write
+      packages: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: true
+          fetch-depth: 0
+          ref: master
+
+      - name: Bump version and create tag
+        uses: jasonamyers/[email protected]
+        id: bump
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DEFAULT_BUMP: ${{ inputs.type }}
+
+      - name: Push tag
+        run: git push origin master --tags
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Create GitHub Release with changelog
+        id: create_release
+        uses: ncipollo/[email protected]
+        with:
+          name: ${{ steps.bump.outputs.new_ver }}
+          bodyFile: CHANGELOG.md
+          tag: ${{ steps.bump.outputs.new_ver }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

@@ -6,6 +6,8 @@
 
 - Enable automated test run as required step for release process
 - Enable basic DependaBot scanning for pip packages and GitHub actions used in CI
+- Add CI support for release proces with [release.yaml](.github/workflows/release.yml) workflow
+  - Release documentation is updated acrodingly in [RELEASING.md](./RELEASING.md)
 
 ## 0.21.0
 

RELEASING.md

@@ -1,6 +1,4 @@
 # How to release
 
-1. Make sure `CHANGELOG.md` is up-to-date with all changes since last release.
-2. Update versions in all three sub-package's `__init__.py` files.
-3. Update `appVersion` in [Chart.yaml](helm/Chart.yaml)
-4. Create a new release on `master` branch with https://github.com/jupyter-incubator/sparkmagic/releases/new — Tag format is "0.15.0", no "v" prefix.
+1. Make sure `CHANGELOG.md` is up-to-date with all changes since last release and available on `master` branch.
+2. Go to Actions -> Release workflow -> Run workflow -> Select `patch|minor|major` depending of the changes you want to release, set `master` branch as desired branch