harness-auto-docs 0.3.1 → 0.3.2
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/README.md +3 -0
- package/README_ja.md +55 -0
- package/README_zh.md +55 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,3 +1,6 @@
|
|
|
1
|
+
[](README_zh.md)
|
|
2
|
+
[](README_ja.md)
|
|
3
|
+
|
|
1
4
|
# harness-auto-docs
|
|
2
5
|
|
|
3
6
|
Auto-generate [Harness Engineering](https://openai.com/research/harness-engineering) style documentation when your project creates a git tag. Opens a PR with updated docs.
|
package/README_ja.md
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
[](README.md)
|
|
2
|
+
[](README_zh.md)
|
|
3
|
+
|
|
4
|
+
# harness-auto-docs
|
|
5
|
+
|
|
6
|
+
プロジェクトの git タグ作成時に、[Harness Engineering](https://openai.com/research/harness-engineering) スタイルのドキュメントを自動生成し、PR を開いてドキュメントを更新します。
|
|
7
|
+
|
|
8
|
+
## 使用方法
|
|
9
|
+
|
|
10
|
+
`.github/workflows/harness-docs.yml` をプロジェクトに追加し（`examples/github-workflow.yml` を参照）、以下を設定します：
|
|
11
|
+
|
|
12
|
+
- `AI_API_KEY` — Anthropic、OpenAI、または MiniMax の API キー（repository secret）
|
|
13
|
+
- `AI_MODEL` — モデル名（例：`claude-sonnet-4-6`、`gpt-4o`、`MiniMax-Text-01`）
|
|
14
|
+
- `GITHUB_TOKEN` — GitHub Actions により自動提供
|
|
15
|
+
|
|
16
|
+
タグをプッシュすると（`git tag v1.2.0 && git push --tags`）、自動的にドキュメントを更新する PR が開きます。
|
|
17
|
+
|
|
18
|
+
## 更新されるファイル
|
|
19
|
+
|
|
20
|
+
| ファイル | 常時更新 | 条件付き更新 |
|
|
21
|
+
|---------|---------|-------------|
|
|
22
|
+
| `AGENTS.md` | ✓ | |
|
|
23
|
+
| `ARCHITECTURE.md` | ✓ | |
|
|
24
|
+
| `docs/DESIGN.md` | ✓ | |
|
|
25
|
+
| `docs/QUALITY_SCORE.md` | ✓ | |
|
|
26
|
+
| `changelog/vX.Y.Z.md` | ✓ | |
|
|
27
|
+
| `docs/design-docs/vX.Y.Z.md` | ✓ | |
|
|
28
|
+
| `docs/design-docs/index.md` | ✓ | |
|
|
29
|
+
| `docs/exec-plans/tech-debt-tracker.md` | ✓ | |
|
|
30
|
+
| `docs/FRONTEND.md` | | フロントエンドファイル変更時 |
|
|
31
|
+
| `docs/SECURITY.md` | | 認証/セキュリティファイル変更時 |
|
|
32
|
+
| `docs/RELIABILITY.md` | | インフラファイル変更時 |
|
|
33
|
+
| `docs/generated/db-schema.md` | | SQL/schema ファイル変更時 |
|
|
34
|
+
| `docs/product-specs/index.md` | | 新機能検出時 |
|
|
35
|
+
| `docs/references/` | | 新規依存関係追加時 |
|
|
36
|
+
|
|
37
|
+
## ローカル実行
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
AI_MODEL=claude-sonnet-4-6 AI_API_KEY=sk-ant-... GITHUB_TOKEN=ghp_... npx harness-auto-docs
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## サポートモデル
|
|
44
|
+
|
|
45
|
+
モデルルーティングは `AI_MODEL` のプレフィックスで決定されます：
|
|
46
|
+
|
|
47
|
+
| プレフィックス | プロバイダー | 対応モデル |
|
|
48
|
+
|--------------|-------------|-----------|
|
|
49
|
+
| `claude-*` | Anthropic | `claude-sonnet-4-6`、`claude-opus-4-6`、`claude-haiku-4-5-20251001` |
|
|
50
|
+
| `gpt-*` | OpenAI | `gpt-4o`、`gpt-4o-mini`、`o3` |
|
|
51
|
+
| `MiniMax-*` | MiniMax（Anthropic 互換） | `MiniMax-Text-01` |
|
|
52
|
+
|
|
53
|
+
## 今後の予定
|
|
54
|
+
|
|
55
|
+
- GitLab サポート（MR 作成）
|
package/README_zh.md
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
[](README.md)
|
|
2
|
+
[](README_ja.md)
|
|
3
|
+
|
|
4
|
+
# harness-auto-docs
|
|
5
|
+
|
|
6
|
+
当项目创建 git tag 时，自动生成 [Harness Engineering](https://openai.com/research/harness-engineering) 风格的文档，并自动开启 PR 更新文档。
|
|
7
|
+
|
|
8
|
+
## 使用方法
|
|
9
|
+
|
|
10
|
+
将 `.github/workflows/harness-docs.yml` 添加到项目中（参见 `examples/github-workflow.yml`），然后设置：
|
|
11
|
+
|
|
12
|
+
- `AI_API_KEY` — 你的 Anthropic、OpenAI 或 MiniMax API 密钥（repository secret）
|
|
13
|
+
- `AI_MODEL` — 模型名称，如 `claude-sonnet-4-6`、`gpt-4o` 或 `MiniMax-Text-01`
|
|
14
|
+
- `GITHUB_TOKEN` — GitHub Actions 自动提供
|
|
15
|
+
|
|
16
|
+
当你推送标签（`git tag v1.2.0 && git push --tags`）时，系统会自动开启一个包含更新文档的 PR。
|
|
17
|
+
|
|
18
|
+
## 更新范围
|
|
19
|
+
|
|
20
|
+
| 文件 | 始终更新 | 条件更新 |
|
|
21
|
+
|------|---------|---------|
|
|
22
|
+
| `AGENTS.md` | ✓ | |
|
|
23
|
+
| `ARCHITECTURE.md` | ✓ | |
|
|
24
|
+
| `docs/DESIGN.md` | ✓ | |
|
|
25
|
+
| `docs/QUALITY_SCORE.md` | ✓ | |
|
|
26
|
+
| `changelog/vX.Y.Z.md` | ✓ | |
|
|
27
|
+
| `docs/design-docs/vX.Y.Z.md` | ✓ | |
|
|
28
|
+
| `docs/design-docs/index.md` | ✓ | |
|
|
29
|
+
| `docs/exec-plans/tech-debt-tracker.md` | ✓ | |
|
|
30
|
+
| `docs/FRONTEND.md` | | 前端文件变更时 |
|
|
31
|
+
| `docs/SECURITY.md` | | 认证/安全文件变更时 |
|
|
32
|
+
| `docs/RELIABILITY.md` | | 基础设施文件变更时 |
|
|
33
|
+
| `docs/generated/db-schema.md` | | SQL/schema 文件变更时 |
|
|
34
|
+
| `docs/product-specs/index.md` | | 检测到新功能时 |
|
|
35
|
+
| `docs/references/` | | 新增依赖时 |
|
|
36
|
+
|
|
37
|
+
## 本地运行
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
AI_MODEL=claude-sonnet-4-6 AI_API_KEY=sk-ant-... GITHUB_TOKEN=ghp_... npx harness-auto-docs
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## 支持的模型
|
|
44
|
+
|
|
45
|
+
模型路由由 `AI_MODEL` 的前缀决定：
|
|
46
|
+
|
|
47
|
+
| 前缀 | 提供商 | 示例模型 |
|
|
48
|
+
|------|--------|---------|
|
|
49
|
+
| `claude-*` | Anthropic | `claude-sonnet-4-6`、`claude-opus-4-6`、`claude-haiku-4-5-20251001` |
|
|
50
|
+
| `gpt-*` | OpenAI | `gpt-4o`、`gpt-4o-mini`、`o3` |
|
|
51
|
+
| `MiniMax-*` | MiniMax（Anthropic 兼容） | `MiniMax-Text-01` |
|
|
52
|
+
|
|
53
|
+
## 未来计划
|
|
54
|
+
|
|
55
|
+
- GitLab 支持（MR 创建）
|