Skip to main content

​
CodeAnt Quality Gate Scan Action

This GitHub Action runs CodeAnt CI quality gate scan with secret detection and code quality analysis on your repository. It integrates seamlessly with your CI/CD pipeline to provide automated scanning and will fail your workflow if secrets are detected or quality gates fail. You can find this action on the GitHub Marketplace.

​
Features

  • 🔒 Secret detection and security scanning
  • 📊 Code quality gate enforcement
  • 🚀 Fast and efficient scanning
  • 🔄 Seamless CI/CD integration
  • 📈 Detailed reports and insights
  • ⏱️ Configurable polling and timeout
  • ✅ Pass/Fail workflow status based on scan results

​
Inputs

NameDescriptionRequiredDefault
access_tokenGitHub PAT or repository token for authenticationYes-
api_baseBase URL for CodeAnt APINohttps://api.codeant.ai
timeoutMaximum time in seconds to wait for resultsNo300
poll_intervalTime in seconds between polling attemptsNo15

​
Usage

​
Basic Example

name: CODEANT QUALITY GATE SCAN

on:
  push:
    branches: [ main, develop ]
  pull_request:
    branches: [ main ]

jobs:
  scan:
    runs-on: ubuntu-latest
    steps:
      - name: Run CodeAnt Scan
        uses: CodeAnt-AI/codeant-quality-gates@v0.0.2
        with:
          access_token: ${{ secrets.GITHUB_TOKEN }}

​
With Custom Configuration

- name: Run CodeAnt Quality Gate Scan
  uses: CodeAnt-AI/codeant-quality-gates@v0.0.2
  with:
    access_token: ${{ secrets.ACCESS_TOKEN_GITHUB }}
    api_base: https://api.codeant.ai
    timeout: 600           # Wait up to 10 minutes for results
    poll_interval: 20      # Poll every 20 seconds

​
Complete Workflow Example

name: CodeAnt Quality Gate

on:
  push:
    branches: [ main, develop ]
  pull_request:
    branches: [ main ]

jobs:
  quality-gate:
    name: Quality Gate Scan
    runs-on: ubuntu-latest
    steps:
      - name: Run CodeAnt Quality Gate Scan
        uses: CodeAnt-AI/codeant-quality-gates@v0.0.2
        with:
          access_token: ${{ secrets.GITHUB_TOKEN }}
          api_base: https://api.codeant.ai
          timeout: 300
          poll_interval: 15

​
Testing from Another Repository

To test this action before publishing to the GitHub Marketplace:
  1. Push this action to a GitHub repository (e.g., CodeAnt-AI/codeant-quality-gates)
  2. In another repository, reference it using the repository path: 
- name: Test CodeAnt Scan
  uses: CodeAnt-AI/codeant-quality-gates@main  # or use a specific branch/tag
  with:
    access_token: ${{ secrets.GITHUB_TOKEN }}
For testing specific commits or branches: 
uses: CodeAnt-AI/codeant-quality-gates@feature-branch
# or
uses: CodeAnt-AI/codeant-quality-gates@abc1234  # commit SHA

​
How It Works

  1. Checkout: Checks out your repository code
  2. Fetch Script: Downloads the quality gates scanning script from CodeAnt API
  3. Start Scan: Initiates the quality gate scan on CodeAnt servers
  4. Poll Results: Continuously polls for scan results until completion or timeout
  5. Report Status: Reports pass/fail status with GitHub annotations

​
Expected Output

When Quality Gate Passes:
✅ Quality Gate PASSED - No secrets detected
The workflow continues successfully. When Quality Gate Fails:
❌ Quality Gate FAILED - Secrets detected or scan error
The workflow fails, preventing merge/deployment.

​
Required Permissions

The access_token requires the following permissions:
  • repo - Full control of private repositories (for reading code)
  • contents: read - Read access to repository contents

​
Quality Gate Checks

Currently, the quality gate performs the following checks:

​
Secret Detection

  • Scans for hardcoded secrets, API keys, passwords, and tokens
  • Analyzes only the changed lines since your merge base commit
  • Uses high-confidence detection to minimize false positives
  • Blocks the build if any secrets are found

​
Best Practices

  1. Run on all branches: Quality gates should run on every push to catch issues early
  2. Block merges: Configure branch protection rules to require quality gate checks before merging
  3. Review failures: When quality gates fail, review the detected issues immediately
  4. Keep tokens secure: Never commit access tokens directly - always use GitHub Secrets

​
Troubleshooting

​
Quality gate times out

If the scan takes longer than expected:
  • Increase the timeout using timeout: 600 (10 minutes)
  • Check if the CodeAnt service is operational

​
Authentication failures

If you see “Access token invalid”:
  • Verify your access_token is correctly configured in GitHub Secrets
  • Ensure the token has appropriate repository permissions

​
No results returned

If the scan completes but returns no results:
  • Check that quality gates are enabled for your repository in CodeAnt
  • Verify the commit SHA is correct

​
License

This project is licensed under the MIT License - see the LICENSE file for details.

​
Support

For issues, questions, or contributions, please visit the GitHub repository.
⌘I