Improve CI workflows and release process (#119)

gaborbernat · web-flow · commit d4642c193ef0 · 2026-01-29T11:53:40.000-08:00
diff --git a/.github/workflows/check.yaml b/.github/workflows/check.yaml
@@ -10,146 +10,139 @@ concurrency:
 
 jobs:
   build:
-    name: Build plugin
+    name: 📦 Build
     runs-on: ubuntu-latest
-    outputs:
-      version: ${{ steps.properties.outputs.version }}
-      changelog: ${{ steps.properties.outputs.changelog }}
-      pluginVerifierHomeDir: ${{ steps.properties.outputs.pluginVerifierHomeDir }}
-      platformVersion: ${{ steps.properties.outputs.platformVersion }}
     steps:
-      - name: Maximize Build Space
+      - name: 🧹 Free disk space
         uses: jlumbroso/free-disk-space@main
         with:
           tool-cache: false
           large-packages: false
-      - name: Checkout git repository
+      - name: 📥 Checkout
         uses: actions/checkout@v6
-      - name: Set up Java
+      - name: ☕ Set up Java
         uses: actions/setup-java@v5
         with:
           distribution: zulu
           java-version: 21
-      - name: Set up Gradle
+      - name: 🐘 Set up Gradle
         uses: gradle/actions/setup-gradle@v5
-      - name: Build plugin
+      - name: 🔨 Build plugin
         run: ./gradlew --console=plain buildPlugin
-      - name: Prepare Plugin Artifact
+      - name: 📁 Prepare artifact
         id: artifact
-        shell: bash
         run: |
           cd ${{ github.workspace }}/build/distributions
           FILENAME=`ls *.zip`
           unzip "$FILENAME" -d content
           echo "filename=${FILENAME:0:-4}" >> $GITHUB_OUTPUT
-      - name: Upload artifact for later download
+      - name: 📤 Upload artifact
         uses: actions/upload-artifact@v6
         with:
           name: ${{ steps.artifact.outputs.filename }}
           path: ./build/distributions/content/*/*
-      - name: Export plugin properties
-        id: properties
-        shell: bash
-        run: |
-          PROPERTIES="$(./gradlew properties --console=plain -q)"
-          VERSION="$(echo "$PROPERTIES" | grep "^version:" | cut -f2- -d ' ')"
-          echo "version=$VERSION" >> $GITHUB_OUTPUT
-          echo "pluginVerifierHomeDir=$HOME/.pluginVerifier" >> $GITHUB_OUTPUT
-          echo "platformVersion=$(echo "$PROPERTIES" | grep "^platformVersion:" | cut -f2- -d ' ')" >> $GITHUB_OUTPUT
-          CHANGELOG="$(./gradlew getChangelog --unreleased --no-header --console=plain -q)"
-          echo "changelog<<EOF" >> $GITHUB_OUTPUT
-          echo "$CHANGELOG" >> $GITHUB_OUTPUT
-          echo "EOF" >> $GITHUB_OUTPUT
 
   verify:
-    name: Verify (${{ matrix.ide }})
-    needs: [build]
+    name: 🔍 Verify (${{ matrix.ide }})
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        ide: [PC, PY]
+        ide: ${{ github.event_name == 'pull_request' && fromJson('["PC"]') || fromJson('["PC", "PY"]') }}
     steps:
-      - name: Free disk space
+      - name: 🧹 Free disk space
         uses: jlumbroso/free-disk-space@main
         with:
           tool-cache: false
           large-packages: false
           android: true
           dotnet: true
-      - name: Checkout git repository
+          haskell: true
+          docker-images: true
+      - name: 📥 Checkout
         uses: actions/checkout@v6
-      - name: Set up Java
+      - name: ☕ Set up Java
         uses: actions/setup-java@v5
         with:
           distribution: zulu
           java-version: 21
-      - name: Set up Gradle
+      - name: 🐘 Set up Gradle
         uses: gradle/actions/setup-gradle@v5
-        with:
-          validate-wrappers: false
-          cache-read-only: false
-      - name: Cache plugin verifier IDEs
+      - name: 💾 Cache verifier IDEs
         uses: actions/cache@v5
         with:
           path: ~/.pluginVerifier/ides
-          key: plugin-verifier-ides-${{ matrix.ide }}-${{ needs.build.outputs.platformVersion }}
-      - name: Clean corrupted Gradle transforms
-        run: rm -rf ~/.gradle/caches/*/transforms
-      - name: Run verification
+          key: plugin-verifier-ides-${{ matrix.ide }}-${{ hashFiles('gradle.properties') }}
+      - name: ✅ Run verification
         run: ./gradlew verifyPlugin -PverifyIde=${{ matrix.ide }}
-      - name: Collect verification result
+      - name: 📤 Upload results
         if: ${{ always() }}
         uses: actions/upload-artifact@v6
         with:
           name: pluginVerifier-result-${{ matrix.ide }}
           path: ${{ github.workspace }}/build/reports/pluginVerifier
 
   lint:
-    name: Lint
-    needs: [build]
+    name: 🧹 Lint
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout git repository
+      - name: 🧹 Free disk space
+        uses: jlumbroso/free-disk-space@main
+        with:
+          tool-cache: false
+          large-packages: false
+      - name: 📥 Checkout
         uses: actions/checkout@v6
-      - name: Set up Java
+      - name: ☕ Set up Java
         uses: actions/setup-java@v5
         with:
           distribution: zulu
           java-version: 21
-      - name: Set up Gradle
+      - name: 🐘 Set up Gradle
         uses: gradle/actions/setup-gradle@v5
-        with:
-          cache-read-only: false
-      - name: Clean corrupted Gradle transforms
-        run: rm -rf ~/.gradle/caches/*/transforms
-      - name: Run linter
+      - name: 🔍 Run linter
         run: ./gradlew ktlintCheck
 
   test:
-    name: Run tests
-    needs: [build]
+    name: 🧪 Unit tests
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout git repository
+      - name: 🧹 Free disk space
+        uses: jlumbroso/free-disk-space@main
+        with:
+          tool-cache: false
+          large-packages: false
+      - name: 📥 Checkout
         uses: actions/checkout@v6
-      - name: Set up Java
+      - name: ☕ Set up Java
         uses: actions/setup-java@v5
         with:
           distribution: zulu
           java-version: 21
-      - name: Set up Gradle
+      - name: 🐘 Set up Gradle
         uses: gradle/actions/setup-gradle@v5
+      - name: ✅ Run tests with coverage
+        run: ./gradlew test koverVerify
+
+  ui-test:
+    name: 🖥️ UI tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🧹 Free disk space
+        uses: jlumbroso/free-disk-space@main
         with:
-          validate-wrappers: false
-          cache-read-only: false
-      - name: Clean corrupted Gradle transforms
-        run: rm -rf ~/.gradle/caches/*/transforms
-      - name: Run unit tests
-        run: ./gradlew test
-      - name: Verify 100% coverage
-        run: ./gradlew koverVerify
-      - name: Run UI tests
+          tool-cache: false
+          large-packages: false
+      - name: 📥 Checkout
+        uses: actions/checkout@v6
+      - name: ☕ Set up Java
+        uses: actions/setup-java@v5
+        with:
+          distribution: zulu
+          java-version: 21
+      - name: 🐘 Set up Gradle
+        uses: gradle/actions/setup-gradle@v5
+      - name: 🖥️ Run UI tests
         run: |
           export DISPLAY=:99.0
           Xvfb :99 -screen 0 1920x1080x24 &
@@ -159,31 +152,3 @@ jobs:
           echo "IDE is ready"
           ./gradlew uiTest
           kill %1 %2 || true
-
-  releaseDraft:
-    name: Create release draft
-    if: github.event_name != 'pull_request'
-    needs: [build, lint, test, verify]
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-    steps:
-      - name: Checkout git repository
-        uses: actions/checkout@v6
-      - name: Remove old release drafts
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          gh api repos/{owner}/{repo}/releases --jq '.[] | select(.draft == true) | .id' \
-            | xargs -I '{}' gh api -X DELETE repos/{owner}/{repo}/releases/{}
-      - name: Create release draft
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          gh release create "v${{ needs.build.outputs.version }}" \
-            --draft \
-            --title "v${{ needs.build.outputs.version }}" \
-            --notes "$(cat << 'EOM'
-          ${{ needs.build.outputs.changelog }}
-          EOM
-          )"
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -1,11 +1,12 @@
-# Running the following secrets to be provided: PUBLISH_TOKEN, PRIVATE_KEY, PRIVATE_KEY_PASSWORD, CERTIFICATE_CHAIN.
+# Secrets required: PUBLISH_TOKEN, PRIVATE_KEY, PRIVATE_KEY_PASSWORD, CERTIFICATE_CHAIN.
 name: Release
 on:
   release:
-    types: [prereleased, released]
+    types: [released]
+
 jobs:
-  release:
-    name: Publish Plugin
+  publish:
+    name: 🚀 Publish
     runs-on: ubuntu-latest
     permissions:
       contents: write
@@ -14,73 +15,79 @@ jobs:
       name: release
       url: https://plugins.jetbrains.com/plugin/20536-pyvenv-manage-2
     steps:
-      - name: Checkout git repository
+      - name: 📥 Checkout
         uses: actions/checkout@v6
         with:
           ref: ${{ github.event.release.tag_name }}
-      - name: Maximize Build Space
+      - name: 🧹 Free disk space
         uses: jlumbroso/free-disk-space@main
         with:
           tool-cache: false
           large-packages: false
-      - name: Set up Java
+      - name: ☕ Set up Java
         uses: actions/setup-java@v5
         with:
           distribution: zulu
           java-version: 21
-      - name: Set up Gradle
+      - name: 🐘 Set up Gradle
         uses: gradle/actions/setup-gradle@v5
-      - name: Extract plugin properties
-        id: properties
-        shell: bash
+      - name: 🏷️ Set version from tag
+        id: version
         run: |
-          CHANGELOG="$(cat << 'EOM' | sed -e 's/^[[:space:]]*$//g' -e '/./,$!d'
-          ${{ github.event.release.body }}
-          EOM
-          )"
-          echo "changelog<<EOF" >> $GITHUB_OUTPUT
-          echo "$CHANGELOG" >> $GITHUB_OUTPUT
-          echo "EOF" >> $GITHUB_OUTPUT
-      - name: Update changelog
-        if: ${{ steps.properties.outputs.changelog != '' }}
-        env:
-          CHANGELOG: ${{ steps.properties.outputs.changelog }}
+          VERSION="${{ github.event.release.tag_name }}"
+          VERSION="${VERSION#v}"
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          sed -i "s/^pluginVersion=.*/pluginVersion=$VERSION/" gradle.properties
+      - name: 📝 Update changelog
+        if: ${{ github.event.release.body != '' }}
         run: |
-          ./gradlew patchChangelog --release-note="$CHANGELOG"
-      - name: Publish to Jetbrains Marketplace
+          cat > /tmp/release-notes.txt << 'RELEASE_NOTES_EOF'
+          ${{ github.event.release.body }}
+          RELEASE_NOTES_EOF
+          ./gradlew patchChangelog --release-note="$(cat /tmp/release-notes.txt)"
+      - name: 📤 Publish to JetBrains Marketplace
         env:
           PUBLISH_TOKEN: ${{ secrets.PUBLISH_TOKEN }}
           CERTIFICATE_CHAIN: ${{ secrets.CERTIFICATE_CHAIN }}
           PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}
           PRIVATE_KEY_PASSWORD: ${{ secrets.PRIVATE_KEY_PASSWORD }}
         run: ./gradlew publishPlugin
-      - name: Upload published plugin as release artifact
+      - name: 📎 Upload release artifact
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: gh release upload ${{ github.event.release.tag_name }} ./build/distributions/*
-      - name: Create pull request with the release
-        if: ${{ steps.properties.outputs.changelog != '' }}
+      - name: 🔢 Calculate next dev version
+        id: next
+        run: |
+          VERSION="${{ steps.version.outputs.version }}"
+          IFS='.' read -r MAJOR MINOR PATCH <<< "$VERSION"
+          NEXT_VERSION="$MAJOR.$MINOR.$((PATCH + 1))-dev"
+          echo "next_version=$NEXT_VERSION" >> $GITHUB_OUTPUT
+      - name: 📝 Create post-release PR
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           VERSION="${{ github.event.release.tag_name }}"
-          BRANCH="changelog-update-$VERSION"
-          LABEL="release changelog"
+          NEXT_VERSION="${{ steps.next.outputs.next_version }}"
+          BRANCH="post-release-$VERSION"
+
+          # Save patched changelog before switching branches
+          cp CHANGELOG.md /tmp/CHANGELOG.md
 
           git config user.email "action@github.com"
           git config user.name "GitHub Action"
 
-          git checkout -b $BRANCH
-          git commit -am "Changelog update - $VERSION"
-          git push --set-upstream origin $BRANCH
+          git fetch origin main
+          git checkout -b $BRANCH origin/main
 
-          gh label create "$LABEL" \
-            --description "Pull requests with release changelog update" \
-            --force \
-            || true
+          sed -i "s/^pluginVersion=.*/pluginVersion=$NEXT_VERSION/" gradle.properties
+          cp /tmp/CHANGELOG.md CHANGELOG.md
+
+          git add gradle.properties CHANGELOG.md
+          git commit -m "Bump version to $NEXT_VERSION after $VERSION release"
+          git push --set-upstream origin $BRANCH
 
           gh pr create \
-            --title "Changelog update - \`$VERSION\`" \
-            --body "Current pull request contains patched \`CHANGELOG.md\` file for the \`$VERSION\` version." \
-            --label "$LABEL" \
+            --title "Bump version to \`$NEXT_VERSION\`" \
+            --body "Post-release version bump after $VERSION release." \
             --head $BRANCH
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -17,7 +17,24 @@ plugins {
 }
 
 group = providers.gradleProperty("pluginGroup").get()
-version = providers.gradleProperty("pluginVersion").get()
+version =
+    providers
+        .gradleProperty("pluginVersion")
+        .get()
+        .let { baseVersion ->
+            if (baseVersion.endsWith("-dev")) {
+                val gitHash =
+                    providers
+                        .exec { commandLine("git", "rev-parse", "--short=8", "HEAD") }
+                        .standardOutput
+                        .asText
+                        .get()
+                        .trim()
+                "$baseVersion+$gitHash"
+            } else {
+                baseVersion
+            }
+        }
 val platformVersion = providers.gradleProperty("platformVersion").get()
 kotlin {
     jvmToolchain(17)
diff --git a/gradle.properties b/gradle.properties
