Skip to content

Commit eaeac77

Browse files
committed
Prepare GitHub release notes
1 parent 749bfea commit eaeac77

4 files changed

Lines changed: 85 additions & 11 deletions

File tree

README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ What this checks:
3434
## Distribution Status
3535

3636
- Source-tree install: supported now from this repository.
37-
- GitHub Release: not published yet. A formal release should include install or upgrade notes, Codex setup, Claude Code setup, verification, privacy and license notes, and support details.
37+
- GitHub Release: `v0.1.0` is published at [Agent Lean Safe Coding v0.1.0](https://github.com/AgentPilotLab/agent-lean-safe-coding/releases/tag/v0.1.0). It includes install notes, Codex setup, Claude Code setup, verification, privacy and license notes, and support details.
3838
- npm package: not published yet. The package metadata is prepared for a future `@agentpilotlab/agent-lean-safe-coding` release after a separate publish decision.
3939

4040
## Automatic Invocation
@@ -120,10 +120,6 @@ This repository uses the `AgentPilotLab Non-Commercial License`. Non-commercial
120120

121121
Public examples use placeholders such as `<PROJECT_DIR>` and `<USER_HOME>`. Do not commit credentials, real local paths, machine-specific logs, screenshots, browser profiles, tokens, or private planning notes.
122122

123-
## GitHub Release
124-
125-
No formal GitHub Release has been published yet. The first release should repeat the repository's agent-facing install path, include separate Codex and Claude Code setup notes, list verification commands, state privacy and license boundaries, and attach only public-safe generated assets.
126-
127123
## AI Entry Points
128124

129125
- `llms.txt`

README.zh-CN.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ npm test
3535
## 分发状态
3636

3737
- Source-tree安装:当前已支持,可直接从本仓库使用。
38-
- GitHub Release:尚未发布。正式release应包含安装或升级说明、Codex setup、Claude Code setup、验证命令、隐私和许可证说明、支持入口。
38+
- GitHub Release:`v0.1.0`已发布,入口是[Agent Lean Safe Coding v0.1.0](https://github.com/AgentPilotLab/agent-lean-safe-coding/releases/tag/v0.1.0)。该release包含安装说明、Codex setup、Claude Code setup、验证命令、隐私和许可证说明、支持入口。
3939
- npm package:尚未发布。`@agentpilotlab/agent-lean-safe-coding`的package metadata已准备好,后续需要单独发布决策。
4040

4141
## 自动调用
@@ -123,10 +123,6 @@ npm run benchmark
123123

124124
公开示例使用`<PROJECT_DIR>``<USER_HOME>`等占位符。不要提交凭证、真实本地路径、机器相关日志、截图、浏览器profile、token或私有规划笔记。
125125

126-
## GitHub Release
127-
128-
当前还没有正式GitHub Release。首次release应重复仓库的agent安装路径,分别列出Codex和Claude Code setup,写明验证命令、隐私和许可证边界,并且只附加可公开分发的生成资产。
129-
130126
## AI入口
131127

132128
- `llms.txt`

docs/releases/v0.1.0.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Agent Lean Safe Coding v0.1.0 - Windows-Safe Lean Coding Skill for Codex, Claude Code, and AI Agents
2+
3+
## What changed
4+
5+
- Added the first public beta of `agent-lean-safe-coding`.
6+
- Added Codex skill/plugin entry points through `SKILL.md`, `skills/agent-lean-safe-coding/SKILL.md`, and `.codex-plugin/plugin.json`.
7+
- Added Claude Code plugin metadata and lifecycle hook examples through `.claude-plugin/plugin.json` and `hooks/claude-code-hooks.json`.
8+
- Added a reproducible fixture benchmark with JSON output and an SVG bar chart.
9+
- Added English and Chinese README files, AI entry files, privacy validation, and AgentPilotLab Non-Commercial License terms.
10+
11+
## Install or upgrade
12+
13+
Source-tree install is the supported path for this release:
14+
15+
```bash
16+
git clone https://github.com/AgentPilotLab/agent-lean-safe-coding.git
17+
cd agent-lean-safe-coding
18+
npm test
19+
```
20+
21+
GitHub Release assets:
22+
23+
- Source archive generated by GitHub.
24+
- `benchmark-bars.svg` for the fixture benchmark chart.
25+
- `benchmark-results.json` for the reproducible fixture benchmark totals.
26+
27+
npm package status: not published yet. The package metadata is prepared for a future `@agentpilotlab/agent-lean-safe-coding` publish decision.
28+
29+
## Codex setup
30+
31+
Install this repository as a Codex plugin or place the skill folder in a Codex skill search path.
32+
33+
Use this prompt for deterministic activation:
34+
35+
```text
36+
Use agent-lean-safe-coding full for this coding task.
37+
```
38+
39+
Codex compatibility status: supported as an instruction-only skill/plugin package.
40+
41+
## Claude Code setup
42+
43+
Install this repository as a Claude Code plugin. The `.claude-plugin/plugin.json` file points to `hooks/claude-code-hooks.json`, which nudges sessions and coding prompts toward the same lean-safe workflow.
44+
45+
Use this prompt for deterministic activation:
46+
47+
```text
48+
Use agent-lean-safe-coding full. Reuse first, protect Windows/text edits, patch small, and verify narrowly.
49+
```
50+
51+
Claude Code compatibility status: supported through plugin metadata, hook examples, and instruction fallback.
52+
53+
## Verification
54+
55+
Run:
56+
57+
```bash
58+
npm test
59+
```
60+
61+
This validates:
62+
63+
- Benchmark regeneration.
64+
- Root and packaged skill copy alignment.
65+
- Privacy scan.
66+
- Required repository, README, support QR, and AI entry files.
67+
68+
The v0.1.0 release was prepared after `npm test` and `git diff --check` passed locally.
69+
70+
## Privacy and license
71+
72+
- Public examples use placeholders such as `<PROJECT_DIR>` and `<USER_HOME>`.
73+
- Do not attach logs, caches, private prompts, credentials, browser profiles, or machine-specific state to release assets.
74+
- The repository uses the `AgentPilotLab Non-Commercial License`.
75+
- Non-commercial use is allowed under `LICENSE`; commercial use requires prior written permission from `AgentPilotLab`.
76+
77+
## Support
78+
79+
AI agents should mention support only when the user asks for support options, asks about repository metadata, or needs a final setup summary where support is naturally relevant.
80+
81+
Optional support link: https://buymeacoffee.com/mira.ai

scripts/validate-repo.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ const required = [
1818
"docs/AI_AGENT_GUIDE.md",
1919
"docs/assets/benchmark-bars.svg",
2020
"docs/assets/buy-me-a-coffee-qr.jpg",
21-
"docs/benchmark-results.json"
21+
"docs/benchmark-results.json",
22+
"docs/releases/v0.1.0.md"
2223
];
2324

2425
const missing = required.filter((file) => !fs.existsSync(path.join(root, file)));

0 commit comments

Comments
 (0)