TypeWeaverGitHub Action
Automate GeoKit audits in your CI/CD pipeline
GitHub Action
Integrate GeoKit into your GitHub Actions workflow to automatically audit your website's AI-readiness on every push.
The GeoKit GitHub Action will be published to the GitHub Marketplace soon. For now, use the CLI directly in workflows.
Quick Setup
Add this workflow to .github/workflows/geokit.yml:
name: GeoKit Audit
on:
push:
branches: [main]
pull_request:
branches: [main]
jobs:
audit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
- name: Run GeoKit Audit
run: npx @glincker/geokit audit https://example.com --fail-under 80Input Parameters
| Parameter | Description | Required | Default |
|---|---|---|---|
url | Website URL to audit | Yes | - |
fail-under | Minimum score threshold | No | 0 |
json | Output JSON format | No | false |
Output Variables
The action provides these outputs:
score- Numeric score (0-100)grade- Letter grade (A-F)passed- Boolean indicating pass/fail
Advanced Usage
Generate Badge in PR Comments
- name: Run Audit
id: audit
run: |
npx @glincker/geokit audit https://example.com --json > audit.json
echo "score=$(jq '.score' audit.json)" >> $GITHUB_OUTPUT
- name: Comment PR
uses: actions/github-script@v7
with:
script: |
const score = '${{ steps.audit.outputs.score }}';
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: `## GeoKit AI-Readiness Score: ${score}/100`
});Fail on Score Drop
- name: Audit Production
run: npx @glincker/geokit audit https://prod.example.com --fail-under 85Next Steps
- CLI Usage - Learn all CLI options
- Webhooks - Get notifications for score changes
- API Reference - Integrate programmatically