在SonarQube创建代码自动检查

配置代码自动检查

使用GitHub账号登录SonarQube首页。
单击上方导航栏“Favorite Projects”，单击“Configure analysis”。

图1 配置代码检查
单击“With GitHub Actions”，进入SonarQube对接GitHub Actions的配置页面。
单击“Settings > Secrets and variables > Actions”，选择“Python”（本案例采用Python语言编码），进入目标代码仓库的新建密钥页面。

图2 对接GitHub Actions的配置参数
单击“New repository secret”，进入密钥信息填写页面。

图3 配置密钥
复制4的“Name”和“Value”值，粘贴至新建密钥页面的“Name”和“Secret”。填写完成后，单击“Add secret”，完成密钥新建。

图4 填写密钥参数
在GitHub成功配置密钥后，请回到4的SonarQube页面，单击“Python”，单击“Windows”，单击“Copy”，复制并保存到本地。
登录GitHub，在“url-link-extractor”代码仓库首页，单击，进入代码仓库的分支页面。单击右上角“New branch”，在“New branch name”填写新代码分支的名称，单击“Create new branch”，即可完成新分支创建。本案例填写分支名为“develop”。
单击“develop”，进入develop分支的代码首页。

图5 进入develop分支首页
单击“Add file”，单击“Create new file”，即可进入文件的新建页面。

图6 进入新建文件页面
复制“.github/workflows/ci.yml”路径并粘贴至文件名的框内，将自动在.github/workflows/路径下新建ci.yml文件。

图7 新建ci.yml文件

将4复制并保存的配置内容粘贴到“ci.yml”文件。当从本地提交代码到develop分支时，代码仓库“url-link-extractor”将自动触发流水线。

name: Build
on:
  push:
    branches:
      - main
      - develop
  pull_request:
    types: [opened, synchronize, reopened]
jobs:
  sonarqube:
    name: SonarQube
    runs-on: windows-latest
    steps:
      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
        with:
          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
      - name: SonarQube Scan
        uses: SonarSource/sonarqube-scan-action@7006c4492b2e0ee0f816d36501671557c97f5995 # v8.1.0
        env:
          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

其中，需要注意的是，本案例基于develop分支进行开发，期望在develop推送时也扫描代码，因此在branches下增加“- develop”值。

内容粘贴完成后，单击右上角“Commit changes”。
单击“Add file”，单击“Create new file”，即可进入文件的新建页面。

图8 进入新建文件页面
切换至develop分支，在根目录下，粘贴4的第3点内容为新建文件名和文件内容后，单击“Commit changes”，再单击“Commit changes”后，将自动跳转到“Code”页面。

图9 Project onboarding的第3点

图10 新建“sonar-project.properties”