SSW CodeAuditor is a code and link analysis tool that allows users to identify broken links or code, view the overall performance of your website, ensuring large, complex source code can be simplified, cleaned and maintained. With CodeAuditor, you can:
Figure: CodeAuditor Architecture Diagram
docker run sswconsulting/codeauditor <YourToken> --url <URL>
Additionally, you can also use CodeAuditor Workflow on GitHub Marketplace and run it as part of your GitHub Action simply by following the steps from CodeAuditor Workflow
Make sure you specifying the following inputs:
name | required | type | description |
---|---|---|---|
GitHub_Token | yes | string | Your repo default GitHub token i.e. using "\${{ github.token }}" |
Make sure you grant the token permission to create issue | |||
token | yes | string | Your personal CodeAuditor token that can be found on CodeAuditor's How It Works page |
url | yes | string | The url used on your CodeAuditor scan |
AlertIssue | no | boolean | Set to "true" if you want to switch on issue alert feature |
GoMaxthread | no | number | Set the maximum number of threads for Golang web scraping (Default is 100) |
Example usage
name: Test CodeAuditor Workflow
jobs:
build:
runs-on: ubuntu-latest
permissions:
issues: write
steps:
- uses: actions/checkout@v3
- name: CodeAuditor Feedback Loop Workflow
uses: tombui99/codeauditor-github-workflow@v1.0.0
with:
# Your CodeAuditor token
token: \${{ secrets.CODEAUDITORTOKEN }}
# Your Scan URL
url: \${{ vars.SCANURL }}
# Your GitHub Token
GitHub_Token: \${{ github.token }}
We always welcome contributions. If you are interested in contributing, please take a look at our CONTRIBUTING guide
SvelteJs - Free and open-source JavaScript framework
Firebase - CodeAuditor uses Firebase API, allowing developers to avoid managing servers or writing server-side code
Docker - Platform as a service (PaaS) product that uses OS-level virtualization to deliver software in packages