Skip to content

Commit 7092ed9

Browse files
authored
PR #18のlink-check機能を追加 (#25)
1 parent fc65dd4 commit 7092ed9

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-0
lines changed

.github/workflows/link-check.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: リンクチェック
2+
3+
# 1,4,7,10月の1日の午前9時(JST)に実行(UTC 0時)
4+
on:
5+
schedule:
6+
- cron: '0 0 1 1,4,7,10 *'
7+
# 手動実行も可能
8+
workflow_dispatch:
9+
10+
jobs:
11+
link-check:
12+
runs-on: ubuntu-latest
13+
permissions:
14+
contents: read
15+
issues: write
16+
17+
steps:
18+
# リポジトリをチェックアウト
19+
- name: Checkout repository
20+
uses: actions/checkout@v4
21+
22+
# リンクチェックを実行
23+
- name: Link Checker
24+
uses: lycheeverse/lychee-action@v1
25+
with:
26+
# public/ディレクトリ内のMarkdownファイルをチェック
27+
args: --verbose --no-progress 'public/**/*.md'
28+
# 壊れたリンクが見つかった場合は失敗とする(Issueで通知)
29+
fail: true
30+
env:
31+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
32+
33+
# リンクチェック結果をアーティファクトとして保存
34+
- name: Upload link check results
35+
if: always()
36+
uses: actions/upload-artifact@v4
37+
with:
38+
name: link-check-results
39+
path: lychee/out.md
40+
retention-days: 30
41+
42+
# 壊れたリンクが見つかった場合にIssueを作成
43+
- name: Create Issue From File
44+
if: failure()
45+
uses: peter-evans/create-issue-from-file@v5
46+
with:
47+
title: リンクチェックで壊れたリンクが検出されました
48+
content-filepath: ./lychee/out.md
49+
labels: bug

SETUP.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,12 @@
4949
- MD013: 行の長さ制限(Qiita記事では長い行が一般的なため)
5050
- MD033: HTML使用(Qiita記事ではHTMLタグが使用されることがあるため)
5151
- MD041: 最初の行は見出しであるべき(Qiitaの記事にはfrontmatterがあるため)
52+
53+
### リンクチェック
54+
55+
記事内のリンクが正しく機能しているかを自動的にチェックします。
56+
57+
- **自動実行**: 1,4,7,10月の1日の午前9時(JST)に自動実行
58+
- **手動実行**: GitHubリポジトリの Actions タブから「リンクチェック」ワークフローを選択し、「Run workflow」ボタンをクリック
59+
- **通知**: 壊れたリンクが見つかった場合は、自動的にIssueが作成されます(bugラベル付き)
60+
- **ログ保存**: チェック結果はアーティファクトとして30日間保存されます

0 commit comments

Comments
 (0)