Skip to content

Commit 87ef8e4

Browse files
web-flowclaude
andcommitted
docs: add link checker CI and improve CHANGELOG v3.0.0 migration guide
- Add .github/workflows/docs-check.yml for automated link checking - Uses lychee-action for Markdown link validation - Includes markdownlint for format checking - Auto-creates issues on link check failures - Enhance CHANGELOG v3.0.0 Breaking Changes section - Add migration script for Loop ID format change (4→5 digits) - Document impact scope (Loop files, ShadowGrandDigest, last_digest_times.json) - Clarify user impact for each breaking change 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent b219e19 commit 87ef8e4

2 files changed

Lines changed: 92 additions & 1 deletion

File tree

.github/workflows/docs-check.yml

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: Documentation Check
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- '**/*.md'
8+
pull_request:
9+
branches: [main]
10+
paths:
11+
- '**/*.md'
12+
13+
jobs:
14+
link-check:
15+
name: Check Markdown Links
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@v4
19+
20+
- name: Link Checker
21+
uses: lycheeverse/lychee-action@v1
22+
with:
23+
args: >-
24+
--verbose
25+
--no-progress
26+
--exclude-mail
27+
--exclude 'https://github.com/Bizuayeu/Plugins-Weave/compare/*'
28+
--exclude 'https://github.com/Bizuayeu/Plugins-Weave/releases/*'
29+
'**/*.md'
30+
fail: true
31+
32+
- name: Create Issue on Failure
33+
if: failure()
34+
uses: actions/github-script@v7
35+
with:
36+
script: |
37+
const title = 'Documentation Link Check Failed';
38+
const body = `The documentation link check has failed in workflow run [#${context.runNumber}](${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}).
39+
40+
Please review the broken links and fix them.`;
41+
42+
// Check if issue already exists
43+
const issues = await github.rest.issues.listForRepo({
44+
owner: context.repo.owner,
45+
repo: context.repo.repo,
46+
state: 'open',
47+
labels: 'documentation'
48+
});
49+
50+
const existingIssue = issues.data.find(issue => issue.title === title);
51+
52+
if (!existingIssue) {
53+
await github.rest.issues.create({
54+
owner: context.repo.owner,
55+
repo: context.repo.repo,
56+
title: title,
57+
body: body,
58+
labels: ['documentation', 'bug']
59+
});
60+
}
61+
62+
markdown-lint:
63+
name: Lint Markdown Files
64+
runs-on: ubuntu-latest
65+
steps:
66+
- uses: actions/checkout@v4
67+
68+
- name: markdownlint-cli2-action
69+
uses: DavidAnson/markdownlint-cli2-action@v16
70+
with:
71+
globs: '**/*.md'
72+
fix: false
73+
continue-on-error: true

EpisodicRAG/CHANGELOG.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1111

1212
### Breaking Changes
1313

14-
- **Loop IDの桁数変更**: 4桁→5桁(例: `Loop0001``L00001`
14+
- **Loop IDの桁数変更**: 4桁→5桁
15+
- 旧形式: `Loop0001`
16+
- 新形式: `L00001`
17+
- **移行方法**: 既存Loopファイルのリネームが必要
18+
```bash
19+
# 例: L0001_xxx.txt → L00001_xxx.txt
20+
cd your_loops_directory
21+
for f in L[0-9][0-9][0-9][0-9]_*.txt; do
22+
mv "$f" "L0${f:1}"
23+
done
24+
```
25+
- **影響範囲**:
26+
- Loopファイル名
27+
- ShadowGrandDigest.txt 内の `source_files` 参照
28+
- last_digest_times.json 内の参照
29+
1530
- **ドキュメントの完全SSoT化**: 用語定義はREADME.mdに一元化
31+
- ユーザーへの影響なし(ドキュメント構造の改善のみ)
32+
1633
- **テストスイートの導入**: pytest + hypothesis によるプロパティベーステスト
34+
- 開発者向け変更、エンドユーザーへの影響なし
1735

1836
### Changed
1937

0 commit comments

Comments
 (0)