插件配置

CNB - TCA 插件配置

如果代码是托管在 cnb.cool 上，可以使用 CNB 上的 TCA 插件，在云原生构建上使用代码分析。

使用指引

先在 TCA 上创建好团队和项目（如果已有，可忽略），并接入 CNB 代码仓库，可参考快速开始。
接入仓库后，进入代码库页面，并点击 插件配置，进入 TCA 插件配置弹框页，并选择 CNB 云原生构建 页签。
提示
- 密钥文件地址参见第3、4、5步骤，如果已存在该地址，可以跳过对应步骤，直接输入到密钥文件地址输入框即可！
- 插件所需的凭证信息为个人敏感信息，请注意保密！
在 cnb.cool 上创建一个新的代码仓库（仓库类型选择密钥仓库，密钥仓库是仅允许页面查看和修改，适用于云原生构建加载密钥的仓库），比如：tca-private-config。

在密钥仓库中创建一个 yaml 文件，比如tca-settings.yml，将第 2 步插件配置截图中的凭证信息拷贝到该文件中，并提交即可。密钥仓库 yaml 文件参数示例如下，点击了解文件引用文档：

token: xxx # TCA 个人凭证信息（个人敏感信息，请注意保密！）。
allow_images:
  # 设置可访问密钥的镜像，此处只允许 tca-plugin 镜像访问。
  - "tencentcom/tca-plugin:latest"
allow_slugs:
  # 设置可访问密钥的代码仓库，默认设置为当前仓库，如有多个仓库需要访问，可按需调整，支持glob表达式。
  - "组织名/仓库名"
allow_events:
  # 设置可访问密钥的触发事件，此处默认设置为全部，可按需修改为特定事件，支持glob表达式。
  - "**"

复制该密钥文件 URL 地址，粘贴到第 2 步插件配置截图中的密钥文件地址输入框中，URL示例：https://cnb.cool/xxx/tca-private-config/-/blob/main/tca-settings.yml
在 CNB 云原生构建 页签选择需要使用的分析方案，如果没有，需要先创建，可参考分析方案。
点击 生成 .cnb.yml TCA 插件配置 按钮，进入 cnb.cool 对应的仓库根目录下，将生成的配置内容复制到 .cnb.yml 中（如果不存在，需要先创建 .cnb.yml 文件，点击了解更多）。

到此插件已配置完毕。如需调整参数配置，可参见 TCA 插件。

# .cnb.yml
"**":  # 触发的分支名，默认所有分支，按需修改，例如 main 分支
  push:  # push触发，也可以用merge_request等触发
  - stages:
    # 代码分析插件
    - name: TCA
      image: tencentcom/tca-plugin:latest
      settings:
        org_sid: xxx  # 团队编号，从TCA官网获取
        team_name: xxx  # 项目名称，从TCA官网获取
        scheme_id: xxx  # 分析方案ID，从TCA官网获取
        scan_dir: "" # 填写目录的相对路径，指定代码仓库下的子目录作为扫描目录，适用于大仓场景只扫描某个模块目录，默认不配置，为扫描代码仓库根目录。
        total_scan: false  # 是否全量扫描，默认为 false，即增量扫描
      settingsFrom:
        # 密钥文件引用
        - https://cnb.cool/xxx/tca-private-config/-/blob/main/tca-settings.yml

提示

生成的插件配置，触发条件默认为所有分支 push 触发，可按需调整，其他插件参数可参见 TCA 插件。

Jenkins - TCA 插件配置

如果团队使用 Jenkins 作为构建工具，可以在 Jenkins 安装 TCA 插件，在 Jenkins CI 中使用代码分析。

安装指引

下载插件，链接如下：
tca-jenkins-plugin-official.hpi
进入 Jenkins 页面，系统管理 -> 插件管理 -> Advanced settings，选择刚下载的 TCA 插件文件上传后部署。

使用指引

先在 TCA 上创建好 团队 和 项目（如果已有，可忽略），并接入代码仓库，可参考快速开始。
接入仓库后，进入代码库页面，并点击 插件配置，进入 TCA 插件配置弹框页，并选择 Jenkins 流水线 页签。
点击了解更多下载 jenkins 插件包
在 Jenkins 流水线 页签选择需要使用的分析方案，如果没有，需要先创建，可参考分析方案。
点击 生成 Jenkinsfile TCA 插件配置 按钮，复制配置信息，然后按需配置到代码库下的 Jenkinsfile 或 流水线 Script 中：
- 代码库 Jenkinsfile 配置
  进入代码仓库根目录下，将生成的配置内容复制到 Jenkinsfile 中（如果不存在，需要先创建 Jenkinsfile 文件，点击了解更多），在流水线中选择 Pipeline script from SCM ，并设置脚本路径为 Jenkinsfile。
- 流水线 Script 配置
  进入 Jenkins 流水线，选择 Pipeline script，将生成的配置内容复制到脚本中。

到此插件已配置完毕。如需调整参数配置，可参考如下：

pipeline {
  agent any
      
  stages {
    stage ('代码分析') {
      steps {
        tca (
          // 必填参数
          scmType: 'git', // 代码库类型
          repoUrl: 'http://xxx', // 代码库地址
          orgSid: 'xxx', // 团队编号，从TCA官网获取
          teamName: 'xxx', // 项目名称，从TCA官网获取
          schemeID: xxx, // 分析方案ID，从TCA官网获取
          token: 'xxx', // 个人凭证信息（个人敏感信息，请注意保密！）
          // 选填参数
          scanDir: '', // 需要分析的相对目录，指定代码仓库下的子目录作为分析目录，适用于大仓场景只分析某个模块目录，默认不配置，为扫描代码仓库根目录。
          total: false, // 是否全量扫描，默认为 false，即增量扫描
          revision: '', // 分析版本号，可通过环境变量'{SCM}_COMMIT'设置(SCM可选[GIT])，默认不配置，为当前工作空间的代码版本
          sourceBranch: '', // 分支名称，可通过环境变量'{SCM}_BRANCH'设置(SCM可选[GIT])，默认不配置，为当前工作空间的代码分支；如拉取代码时未指定分支，则该选项为必填
          targetBranch: '' // 需要对比的目标分支名称，适用于MR场景，可通过环境变量'{SCM}_TARGET_BRANCH'设置(SCM可选[GIT])，默认为空
        )
      }
    }
  }
}

提示

可以按需将 tca 步骤提取出来写入 Jenkins 流水线 的任意阶段中！

VSCode - TCA 插件配置

安装指引

下载插件，链接如下：
tca-vscode-plugin.vsix
在VS Code扩展界面点击右上角省略菜单中的"从VSIX安装..."，选择安装刚下载完成的插件文件（文件后缀为.vsix）。

使用指引

先在 TCA 上创建好 团队 和 项目（如果已有，可忽略），接入待分析的代码仓库，按需求配置分析方案，创建分析项目。可参考快速开始。
进入团队界面，点击右侧菜单中的IDE 插件项，根据指引安装本地客户端（如果已安装，可忽略），填写插件配置。
打开插件界面，点击立即分析，等待分析完成，即可查看分析结果。
如果该分析项目已经完成过在线分析，并且代码自上一次分析后没有变动，可以点击下载分析结果，直接查看结果。