harness-auto-docs 0.1.1 → 0.2.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/ci.yml +30 -0
- package/.github/workflows/release.yml +56 -0
- package/AGENTS.md +6 -0
- package/dist/cli.js +0 -0
- package/package.json +11 -9
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
pull_request:
|
|
7
|
+
branches: [main]
|
|
8
|
+
|
|
9
|
+
jobs:
|
|
10
|
+
test:
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
|
|
13
|
+
steps:
|
|
14
|
+
- uses: actions/checkout@v4
|
|
15
|
+
|
|
16
|
+
- uses: pnpm/action-setup@v4
|
|
17
|
+
|
|
18
|
+
- uses: actions/setup-node@v4
|
|
19
|
+
with:
|
|
20
|
+
node-version: '20'
|
|
21
|
+
cache: 'pnpm'
|
|
22
|
+
|
|
23
|
+
- name: Install dependencies
|
|
24
|
+
run: pnpm install --frozen-lockfile
|
|
25
|
+
|
|
26
|
+
- name: Build
|
|
27
|
+
run: pnpm build
|
|
28
|
+
|
|
29
|
+
- name: Run tests
|
|
30
|
+
run: pnpm test
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
name: Release
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
tags:
|
|
6
|
+
- 'v*'
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
publish:
|
|
10
|
+
runs-on: ubuntu-latest
|
|
11
|
+
|
|
12
|
+
steps:
|
|
13
|
+
- uses: actions/checkout@v4
|
|
14
|
+
with:
|
|
15
|
+
fetch-depth: 0
|
|
16
|
+
|
|
17
|
+
- uses: pnpm/action-setup@v4
|
|
18
|
+
|
|
19
|
+
- uses: actions/setup-node@v4
|
|
20
|
+
with:
|
|
21
|
+
node-version: '20'
|
|
22
|
+
cache: 'pnpm'
|
|
23
|
+
|
|
24
|
+
- name: Install dependencies
|
|
25
|
+
run: pnpm install --frozen-lockfile
|
|
26
|
+
|
|
27
|
+
- name: Build
|
|
28
|
+
run: pnpm build
|
|
29
|
+
|
|
30
|
+
- name: Configure npm authentication
|
|
31
|
+
run: echo '//registry.npmjs.org/:_authToken=${NPM_TOKEN}' > .npmrc
|
|
32
|
+
|
|
33
|
+
- name: Publish to npm
|
|
34
|
+
run: pnpm publish --no-git-checks
|
|
35
|
+
env:
|
|
36
|
+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
37
|
+
|
|
38
|
+
update-docs:
|
|
39
|
+
runs-on: ubuntu-latest
|
|
40
|
+
needs: publish # Wait for npm publish so npx@latest uses the new version
|
|
41
|
+
|
|
42
|
+
steps:
|
|
43
|
+
- uses: actions/checkout@v4
|
|
44
|
+
with:
|
|
45
|
+
fetch-depth: 0 # Required: fetch all tags for diff
|
|
46
|
+
|
|
47
|
+
- uses: actions/setup-node@v4
|
|
48
|
+
with:
|
|
49
|
+
node-version: '20'
|
|
50
|
+
|
|
51
|
+
- name: Generate and PR Harness Engineering docs
|
|
52
|
+
run: npx harness-auto-docs@latest
|
|
53
|
+
env:
|
|
54
|
+
AI_MODEL: ${{ vars.AI_MODEL || 'MiniMax-Text-01' }}
|
|
55
|
+
AI_API_KEY: ${{ secrets.AI_API_KEY }}
|
|
56
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
package/AGENTS.md
CHANGED
|
@@ -40,6 +40,12 @@ doc targets, calls an LLM (Claude or GPT), writes Markdown files, and opens a Gi
|
|
|
40
40
|
| `docs/product-specs/index.md` | Feature spec index |
|
|
41
41
|
| `docs/references/` | Library-specific LLM reference files |
|
|
42
42
|
|
|
43
|
+
## Keeping documentation in sync
|
|
44
|
+
|
|
45
|
+
- **README.md must be updated on every project change.** Since agents can only see repo-local artifacts, stale README content is invisible and misleading. Any PR that changes functionality, API, or configuration must update the corresponding README section.
|
|
46
|
+
- **Knowledge lives in `docs/` as the system of record.** `AGENTS.md` is the table of contents (~100 lines), not the encyclopedia. Deep context lives in structured `docs/` files.
|
|
47
|
+
- **Doc-gardening is continuous.** A recurring process scans for stale or obsolete documentation that does not reflect real code and opens fix-up pull requests.
|
|
48
|
+
|
|
43
49
|
## Conventions
|
|
44
50
|
|
|
45
51
|
- **Language / runtime**: TypeScript, ESM (`"type": "module"`), Node ≥18, built with `tsc`
|
package/dist/cli.js
CHANGED
|
File without changes
|
package/package.json
CHANGED
|
@@ -1,17 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "harness-auto-docs",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.8",
|
|
4
4
|
"description": "Auto-generate Harness Engineering docs on git tag",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
7
7
|
"harness-auto-docs": "./dist/cli.js"
|
|
8
8
|
},
|
|
9
|
-
"scripts": {
|
|
10
|
-
"build": "tsc",
|
|
11
|
-
"dev": "tsx src/cli.ts",
|
|
12
|
-
"test": "vitest run",
|
|
13
|
-
"test:watch": "vitest"
|
|
14
|
-
},
|
|
15
9
|
"dependencies": {
|
|
16
10
|
"@anthropic-ai/sdk": "^0.39.0",
|
|
17
11
|
"@octokit/rest": "^21.0.0",
|
|
@@ -26,5 +20,13 @@
|
|
|
26
20
|
"engines": {
|
|
27
21
|
"node": ">=18"
|
|
28
22
|
},
|
|
29
|
-
"
|
|
30
|
-
|
|
23
|
+
"publishConfig": {
|
|
24
|
+
"git-checks": false
|
|
25
|
+
},
|
|
26
|
+
"scripts": {
|
|
27
|
+
"build": "tsc",
|
|
28
|
+
"dev": "tsx src/cli.ts",
|
|
29
|
+
"test": "vitest run",
|
|
30
|
+
"test:watch": "vitest"
|
|
31
|
+
}
|
|
32
|
+
}
|