GitHub Actions 使用 Qodana 传递环境变量技巧

问题描述

在使用 Qodana 进行代码扫描时，如果项目依赖于私有 Maven 仓库，则需要将访问仓库的用户名和密码传递给 Qodana。一种常见的方法是使用 args 参数，将环境变量传递给 Qodana 扫描。然而，如果配置不正确，可能会导致构建失败，并出现类似 "The following Gradle properties are missing" 的错误。

解决方案

问题的根源在于 args 参数中，环境变量的传递方式。正确的配置方式是使用逗号 , 分隔 -e 和环境变量名。

以下是错误的配置示例：

- name: 'Qodana Scan'
  uses: JetBrains/[email protected]
  with:
     args: -e ORG_GRADLE_PROJECT_onstructiveUsername=${{ secrets.M2_USER }},-e ORG_GRADLE_PROJECT_onstructivePassword=${{ secrets.M2_PWD }}

正确的配置示例：

- name: 'Qodana Scan'
  uses: JetBrains/[email protected]
  with:
     args: -e,ORG_GRADLE_PROJECT_onstructiveUsername=${{ secrets.M2_USER }},-e,ORG_GRADLE_PROJECT_onstructivePassword=${{ secrets.M2_PWD }}

关键的区别在于，-e 和环境变量名之间使用了逗号 , 进行分隔。

完整示例

以下是一个完整的 GitHub Actions YAML 配置文件示例，展示了如何正确地将环境变量传递给 Qodana 扫描：

name: Qodana
on:
  workflow_dispatch:
  pull_request:
  push:
    branches:
      - '[0-9]+.[0-9]+.x'

jobs:
  qodana:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: 'Qodana Scan'
        uses: JetBrains/[email protected]
        with:
          args: -e,ORG_GRADLE_PROJECT_onstructiveUsername=${{ secrets.M2_USER }},-e,ORG_GRADLE_PROJECT_onstructivePassword=${{ secrets.M2_PWD }}

注意事项

• 确保在 GitHub 仓库的 Secrets 中配置了 M2_USER 和 M2_PWD 环境变量。
• 仔细检查 args 参数中环境变量的配置，确保使用逗号 , 分隔 -e 和环境变量名。
• 如果仍然遇到问题，可以尝试使用 Docker 镜像本地运行 Qodana，以便更好地调试问题。

总结

正确地将环境变量传递给 Qodana 扫描是确保代码质量检查顺利进行的关键。通过使用逗号 , 分隔 -e 和环境变量名，可以避免因凭据缺失导致的构建失败。希望本文能够帮助您在使用 GitHub Actions 运行 Qodana 时，成功传递环境变量，并获得准确的代码质量分析结果。