Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/workflows/release-goal-audit.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Release goal-audit

on:
push:
tags:
- 'goal-audit-v*'

permissions:
contents: read
id-token: write

jobs:
test-and-publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6

- uses: actions/setup-node@v6
with:
node-version: '22'
registry-url: 'https://registry.npmjs.org'
cache: 'npm'
cache-dependency-path: tools/goal-audit/package-lock.json

- name: Ensure npm supports trusted publishing (OIDC)
run: npm install -g npm@latest

- name: Install, build, test
working-directory: tools/goal-audit
run: |
npm ci
npm run build
npm test

- name: Publish to npm
working-directory: tools/goal-audit
run: npm publish --access public --provenance
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ build/
**/node_modules/
!tools/loop-audit/dist/
!tools/loop-cost/dist/
!tools/goal-audit/dist/
*.egg-info/

# State files that should not be committed in consumer projects (reference repo dogfoods STATE.md)
Expand Down
27 changes: 27 additions & 0 deletions tools/goal-audit/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# goal-audit

Goal Readiness Score CLI for Grok Build `/goal` workflows.

## Install / run

```bash
npx @cobusgreyling/goal-audit .
npx @cobusgreyling/goal-audit . --suggest
npx @cobusgreyling/goal-audit . --json
```

## Levels

| Level | Score | Meaning |
|-------|-------|---------|
| G0 | < 40 | Ad hoc `/goal` usage |
| G1 | 40–59 | GOAL.md + assisted goals |
| G2 | 60–79 | Verifier + test gates |
| G3 | 80+ | CI, budget, run log |

## Development

```bash
npm install
npm test
```
54 changes: 54 additions & 0 deletions tools/goal-audit/dist/auditor.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
export interface GoalSignals {
goalFile: {
present: boolean;
path?: string;
};
goalConfig: {
present: boolean;
};
skills: {
count: number;
goalSkills: string[];
};
verifier: {
present: boolean;
};
scoper: {
present: boolean;
};
agentsMd: {
present: boolean;
mentionsGoal: boolean;
};
patterns: {
documented: boolean;
};
safety: {
safetyDocPresent: boolean;
budgetDoc: boolean;
};
tests: {
present: boolean;
};
ci: {
present: boolean;
};
runLog: {
present: boolean;
};
}
export interface Finding {
level: 'ok' | 'warn' | 'fail';
message: string;
}
export interface AuditResult {
target: string;
score: number;
level: 'G0' | 'G1' | 'G2' | 'G3';
assessment: string;
signals: GoalSignals;
findings: Finding[];
recommendations: string[];
}
export declare function auditProject(target: string): Promise<AuditResult>;
//# sourceMappingURL=auditor.d.ts.map
1 change: 1 addition & 0 deletions tools/goal-audit/dist/auditor.d.ts.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

240 changes: 240 additions & 0 deletions tools/goal-audit/dist/auditor.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading