TCA-action 完整模式

{
    "status":"success|failure|error",
    "url":"结果链接",
    "text":"通过|不通过|异常",
    "description":"结果详细描述",
    "scan_report":{
	    "lintscan":"代码检查结果",
	    "cyclomaticcomplexityscan":"圈复杂度结果",
	    "duplicatescan":"重复代码结果",
	    "clocscan":"代码统计结果"
    },
    "metrics": {                 # 质量门禁数据
	    "incr_fatal": {
	      "value": 0         # 本次扫描新增(致命)问题量
	    },
	    "incr_error": {      
	      "value": 0         # 本次扫描新增(致命+错误)问题量
	    },
	    "incr_warning": {
	      "value": 0         # 本次扫描新增(致命+错误+警告)问题量       
	    },
	    "incr_info": {
	      "value": 0         # 本次扫描新增所有(致命+错误+警告+提示)问题量  
	    },
	    "total_fatal": {
	      "value": 0         # 当前分支(致命)问题量
	    },
	    "total_error": {     
	      "value": 9         # 当前分支(致命+错误)问题量
	    },
	    "total_warning": {
	      "value": 9         # 当前分支(致命+错误+警告)问题量
	    },
	    "total_info": {
	      "value": 9         # 当前分支(致命+错误+警告+提示)问题量
	    },
	    "worse_cc_file_num": {
	      "value": 0         # 圈复杂度恶化文件数
	    },
	    "over_cc_sum": {
	      "value": 36        # 超标圈复杂度总数
	    },
	    "cc_func_average": {
	      "value": 2.947     # 代码平均圈复杂度
	    },
	    "over_cc_func_count": {
	      "value": 10        # 圈复杂度超标方法数
	    },
	    "diff_over_cc_func_count": {
	      "value": 0         # 变更圈复杂度超标方法数
	    },
	    "over_cc_func_average": {
	      "value": 8.6       # 超标方法平均圈复杂度   
	    },
	    "duplicate_rate": {
	      "value": 44.3      # 代码重复率
	    }
    }
}

Example usage

在github仓库的工作流目录（如果.github/workflows目录不存在，先创建）下增加以下tca.yml文件，并提交即可。每次代码提交操作，都将触发一次TCA代码分析。

.github/workflows/tca.yml

1. push触发配置示例

name: TCA

on: [push]

jobs:
  TCA:
    name: Tencent Cloud Code Analysis
    runs-on: ubuntu-latest
    env:
      INPUT_QUICK_SCAN: false
      INPUT_SERVER_IP: 按实际填写
      INPUT_TOKEN: 按实际填写
      INPUT_ORG_SID: 按实际填写
      INPUT_TEAM_NAME: 按实际填写
      INPUT_SCHEME_ID: 按实际填写
      INPUT_TOTAL_SCAN: false
      INPUT_INCR_INFO: 0
      INPUT_TOTAL_INFO: 0
    container:
      image: bensonhome/tca-action
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Tencent Cloud Code Analysis
        run: /tca_action/entrypoint.sh

2. pull_request触发配置示例

需要配置INPUT_COMPARE_BARNCH为${{ github.event.pull_request.base.ref }}，也就是将对比分支设置为pull_request的目标分支。
checkout拉代码步骤，需要配置ref参数，指定拉取pull_request的源分支代码。（否则默认会进行预合入操作，产生临时版本号）。
checkout参数fetch-depth设置为0，需要拉取所有分支，否则无法进行pull_request源分支与目标分支间的对比。

name: TCA

on:
  pull_request:
    branches:
      - main

jobs:
  TCA:
    name: Tencent Cloud Code Analysis
    runs-on: ubuntu-latest
    env:
      INPUT_QUICK_SCAN: false
      INPUT_SERVER_IP: 按实际填写
      INPUT_TOKEN: 按实际填写
      INPUT_ORG_SID: 按实际填写
      INPUT_TEAM_NAME: 按实际填写
      INPUT_SCHEME_ID: 按实际填写
      INPUT_TOTAL_SCAN: false
      INPUT_COMPARE_BRANCH: ${{ github.event.pull_request.base.ref }}
    container:
      image: bensonhome/tca-action
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          ref: ${{ github.event.pull_request.head.ref }}
          fetch-depth: 0
      - name: Tencent Cloud Code Analysis
        run: /tca_action/entrypoint.sh