CodeSweep GitHub アクション

1. ASoC にログインしたら、API ページに移動して API 鍵/秘密のペアを生成します。これらは、アクションの asoc_key および asoc_secret パラメーターで使用する必要があります。これらのパラメーターを秘密としてリポジトリーに保存します
2. リポジトリーの「ワークフロー許可」が「読み取りおよび書き込み許可」に設定されていることを確認します。これにより、CodeSweep はファイルをスキャンし、検出された問題のチェックランとアノテーションを作成できます。これらの設定には、「設定」 > 「アクション」 > 「全般」からアクセスします。
3. プル要求を開いたときにコードの変更をスキャンするには、次のファイルを .github/workflows/codesweep.yml の下のリポジトリーに追加するか、既存のワークフロー・ファイルを更新します。

   name: "HCL AppScan CodeSweep"
   on:
     pull_request:
       types: [opened,synchronize]
   jobs:
     scan:
       runs-on: ubuntu-latest
       steps:
         - name: Checkout
           uses: actions/checkout@v4
           with:
             fetch-depth: 0
         - name: Run AppScan CodeSweep
           uses: HCL-TECH-SOFTWARE/appscan-codesweep-action@v2.1
       env: 
         GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

   注: checkout@v2 以降を使用する場合は、fetch-depth を 0 に設定する必要があります。例:

   uses: actions/checkout@v2
   with:
     fetch-depth: 0

4. プル要求をマージするときにセキュリティーの問題を ASoC に公開するには、次のファイルを .github/workflows/codesweep_publish.yml の下のリポジトリーに追加するか、既存のワークフロー・ファイルを更新します。

   name: "HCL AppScan CodeSweep"
   on:
     pull_request:
       types: [closed]
   jobs:
     publish:
       runs-on: ubuntu-latest
       steps:
         - name: Publish issues to ASoC
           uses: HCL-TECH-SOFTWARE/appscan-codesweep-action@v2.1
           with:
             asoc_key: ${{secrets.ASOC_KEY}}
             asoc_secret: ${{secrets.ASOC_SECRET}}
             publish_on_merge: true
             application_id: <your ASoC application ID>
       env: 
         GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

with:
  status: failure

with:
  publish_on_merge: true
  application_id: 6c058381-17ca-e711-8de5-002590ac753d
  issue_status: "inprogress"
  scan_base_name: "CodeSweep"
  personal_scan: true