Add Cache Control

Author: xterao

.github/workflows/build.yml

@@ -1,10 +1,8 @@
 # GitHub Actions Workflow is created for testing and preparing the plugin release in the following steps:
 # - Validate Gradle Wrapper.
 # - Run 'test' and 'verifyPlugin' tasks.
-# - Run Qodana inspections.
 # - Run the 'buildPlugin' task and prepare artifact for further tests.
 # - Run the 'runPluginVerifier' task.
-# - Create a draft release.
 #
 # The workflow is triggered on push and pull_request events.
 #
@@ -14,71 +12,66 @@
 
 name: Build
 on:
-  # Trigger the workflow on pushes to only the 'main' branch (this avoids duplicate checks being run e.g., for dependabot pull requests)
   push:
-    branches: [ feture/sql-formatter, main ]
-  # Trigger the workflow on any pull request
+    branches:
+      - 'main'
+      - 'feture/sql-formatter'
   pull_request:
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
   cancel-in-progress: true
-  
+
 jobs:
 
-  # Prepare environment and build the plugin
   build:
     name: Build
     runs-on: ubuntu-24.04
     outputs:
-      version: ${{ steps.properties.outputs.version }}
-      changelog: ${{ steps.properties.outputs.changelog }}
       pluginVerifierHomeDir: ${{ steps.properties.outputs.pluginVerifierHomeDir }}
     steps:
-
-      # Check out the current repository
       - name: Fetch Sources
         uses: actions/checkout@v4
 
-      # Validate wrapper
       - name: Gradle Wrapper Validation
         uses: gradle/actions/wrapper-validation@v4
 
-      # Set up Java environment for the next steps
       - name: Setup Java
         uses: actions/setup-java@v4
         with:
           distribution: zulu
           java-version: 17
 
-      # Setup Gradle
       - name: Setup Gradle
         uses: gradle/actions/setup-gradle@v4
 
-      # Set environment variables
       - name: Export Properties
         id: properties
         shell: bash
         run: |
           PROPERTIES="$(./gradlew properties --console=plain -q)"
-          VERSION="$(echo "$PROPERTIES" | grep "^version:" | cut -f2- -d ' ')"
-          CHANGELOG="$(./gradlew getChangelog --unreleased --no-header --console=plain -q)"
-
-          echo "version=$VERSION" >> $GITHUB_OUTPUT
           echo "pluginVerifierHomeDir=~/.pluginVerifier" >> $GITHUB_OUTPUT
-          
-          echo "changelog<<EOF" >> $GITHUB_OUTPUT
-          echo "$CHANGELOG" >> $GITHUB_OUTPUT
-          echo "EOF" >> $GITHUB_OUTPUT
 
-      # Generate Lexer and Parser
+      - name: Cache Lexer and Parser
+        uses: actions/cache@v4
+        id: cache-lexer-parser
+        with:
+          path: ${{ github.workspace }}/src/main/gen
+          key: lexer-parser-${{ hashFiles('**/Sql.bnf','**/Sql.flex') }}
+          restore-keys: |
+            lexer-parser-
+
       - name: Generate Lexer
+        if: steps.cache-lexer-parser.outputs.cache-hit != 'true'
         run: ./gradlew generateLexer
 
       - name: Generate Parser
+        if: steps.cache-lexer-parser.outputs.cache-hit != 'true'
         run: ./gradlew generateParser
 
-      # Build plugin
+      - name: Build Gradle
+        run: ./gradlew build -x test
+
       - name: Build plugin
         run: ./gradlew buildPlugin -PpluginVersion=0.4.0-${{ github.run_number }}
 
@@ -121,12 +114,24 @@ jobs:
       # Setup Gradle
       - name: Setup Gradle
         uses: gradle/actions/setup-gradle@v4
+        with:
+          cache-read-only: true
+
+      - name: Cache Lexer and Parser
+        uses: actions/cache@v4
+        id: cache-lexer-parser
+        with:
+          path: ${{ github.workspace }}/src/main/gen
+          key: lexer-parser-${{ hashFiles('**/Sql.bnf','**/Sql.flex') }}
+          restore-keys: |
+            lexer-parser-
 
-      # Generate Lexer and Parser
       - name: Generate Lexer
+        if: steps.cache-lexer-parser.outputs.cache-hit != 'true'
         run: ./gradlew generateLexer
 
       - name: Generate Parser
+        if: steps.cache-lexer-parser.outputs.cache-hit != 'true'
         run: ./gradlew generateParser
 
       # Run tests
@@ -147,53 +152,6 @@ jobs:
         with:
           files: ${{ github.workspace }}/build/reports/kover/report.xml
 
-  # Run Qodana inspections and provide report
-  inspectCode:
-    name: Inspect code
-    needs: [ build ]
-    runs-on: ubuntu-24.04
-    permissions:
-      contents: write
-      checks: write
-      pull-requests: write
-    steps:
-
-      # Free GitHub Actions Environment Disk Space
-      - name: Maximize Build Space
-        uses: jlumbroso/free-disk-space@main
-        with:
-          tool-cache: false
-          large-packages: false
-
-      # Check out the current repository
-      - name: Fetch Sources
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ github.event.pull_request.head.sha }}  # to check out the actual pull request commit, not the merge commit
-          fetch-depth: 0  # a full history is required for pull request analysis
-
-      # Set up Java environment for the next steps
-      - name: Setup Java
-        uses: actions/setup-java@v4
-        with:
-          distribution: zulu
-          java-version: 17
-
-      # Generate Lexer and Parser
-      - name: Generate Lexer
-        run: ./gradlew generateLexer
-
-      - name: Generate Parser
-        run: ./gradlew generateParser
-
-      # Run Qodana inspections
-      - name: Qodana - Code Inspection
-        uses: JetBrains/[email protected]
-        with:
-          cache-default-branch-only: true
-          upload-result: true
-
-  # Run plugin structure verification along with IntelliJ Plugin Verifier
   verify:
     name: Verify plugin
     needs: [ build ]
@@ -221,12 +179,24 @@ jobs:
       # Setup Gradle
       - name: Setup Gradle
         uses: gradle/actions/setup-gradle@v4
+        with:
+          cache-read-only: true
+
+      - name: Cache Lexer and Parser
+        uses: actions/cache@v4
+        id: cache-lexer-parser
+        with:
+          path: ${{ github.workspace }}/src/main/gen
+          key: lexer-parser-${{ hashFiles('**/Sql.bnf','**/Sql.flex') }}
+          restore-keys: |
+            lexer-parser-
 
-      # Generate Lexer and Parser
       - name: Generate Lexer
+        if: steps.cache-lexer-parser.outputs.cache-hit != 'true'
         run: ./gradlew generateLexer
 
       - name: Generate Parser
+        if: steps.cache-lexer-parser.outputs.cache-hit != 'true'
         run: ./gradlew generateParser
 
       # Cache Plugin Verifier IDEs
@@ -246,41 +216,4 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: pluginVerifier-result
-          path: ${{ github.workspace }}/build/reports/pluginVerifier
-
-  # Prepare a draft release for GitHub Releases page for the manual verification
-  # If accepted and published, release workflow would be triggered
-  releaseDraft:
-    name: Release draft
-    if: github.event_name != 'pull_request'
-    needs: [ build, test, inspectCode, verify ]
-    runs-on: ubuntu-24.04
-    permissions:
-      contents: write
-    steps:
-
-      # Check out the current repository
-      - name: Fetch Sources
-        uses: actions/checkout@v4
-
-      # Remove old release drafts by using the curl request for the available releases with a draft flag
-      - 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/{}
-
-      # Create a new release draft which is not publicly visible and requires manual acceptance
-      - 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
-          )"
+          path: ${{ github.workspace }}/build/reports/pluginVerifier