如何消除GitHub Actions中Gradle内存缓存缺失警告

问题描述 #

GitHub Actions执行Gradle构建时出现以下警告：

Performance may suffer from in-memory cache misses. Increase max heap size of Gradle build process to reduce cache misses.

对应的GitHub Actions配置如下：

name: SonarQube
on:
  push:
    branches:
      - master # or the name of your main branch
  pull_request:
    types: [opened, synchronize, reopened]

jobs:
  build:
    name: SonarQube
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
      - name: Set up JDK 11
        uses: actions/setup-java@v3
        with:
          java-version: 11
          distribution: corretto
          cache: gradle
      - name: Build and analyze
        env:
          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
          SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
        run: ./gradlew --info sonarqube -Dsonar.host.url=$SONAR_HOST_URL -Dsonar.login=$SONAR_TOKEN

修改方案 #

要消除该警告，需为Gradle进程增加最大堆内存，以下是两种可行方式：

方式一：在构建命令中直接指定JVM参数 #

修改Build and analyze步骤的run命令，添加-Xmx参数设置堆内存大小（示例设置为4GB，可根据项目规模调整）：

- name: Build and analyze
  env:
    SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
    SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
  run: ./gradlew --info sonarqube -Xmx4g -Dsonar.host.url=$SONAR_HOST_URL -Dsonar.login=$SONAR_TOKEN

方式二：通过环境变量统一配置 #

在Build and analyze步骤的env中添加GRADLE_OPTS环境变量，全局设置JVM参数：

- name: Build and analyze
  env:
    SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
    SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
    GRADLE_OPTS: "-Xmx4g"
  run: ./gradlew --info sonarqube -Dsonar.host.url=$SONAR_HOST_URL -Dsonar.login=$SONAR_TOKEN

两种方式均可提升Gradle的内存分配，减少缓存命中失败情况，从而消除警告。

内容的提问来源于stack exchange，提问作者MrAndre