ci: API ドキュメントの Pages 掲載と CHANGELOG を追加する - #31
Merged
Merged
Conversation
リリース毎に Dokka HTML を GitHub Pages へ deploy する。deploy はサイト全体を置き換えるため、 過去版の閲覧を保つには生成のたびに全版を作り直す必要がある。版切替 UI を出す Dokka の versioning プラグインを入れ、過去版の出力は gh-pages ブランチを保管場所として持つ。 保管するのは各版の出力から older/ を除いたもので、除かないと版を重ねるたびに過去版が 入れ子で積み上がる。保管ブランチの更新は通常のコミットで行う（保護設定と整合させるため）。 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
リリース毎の変更点の記載先を用意する。初回は機能の説明を README が担うため記載を置かない。 版表記の同期タスクの対象には含めない（履歴として残す過去の版が、現行版へ書き換えられてしまうため）。 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
k163377
force-pushed
the
docs/pages-deploy
branch
from
August 8, 2026 05:53
04fe834 to
2a351d3
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
リリース工程に残っていた 2 点を実装する。
API ドキュメントの掲載
actions/deploy-pagesはサイト全体を置き換えるため、過去版の閲覧を保つには生成のたびに全版を作り直す必要がある。Dokka の versioning プラグインで版切替 UI を構成し、過去版の出力は
gh-pagesブランチを保管場所として持つ（Pages のソースは Actions のため、保管ブランチの内容が直接配信されることはない）。
実地で確認した点:
older/を除いたもの。除かないと版を重ねるたびに過去版が入れ子で積み上がるversion.jsonが正で、保管先のディレクトリ名は参照されないolder/<版>/index.htmlが引けることと、ドロップダウンに両版が並ぶことを確認済み
github-pagesenvironment の deployment branch policy はタグv*を許可済み（既定の
mainのみではタグ駆動の deploy が拒否される）。なお版切替リンクの区切り文字はプラットフォーム依存で、Windows で生成するとリンクが壊れる。
掲載物は ubuntu で生成するため実害は無い。
CHANGELOG
Keep a Changelog 形式・英語で作成する。版表記の同期タスクの対象には含めない
（履歴として残す過去の版が現行版へ書き換えられてしまうため、その旨をルートのビルドスクリプトにも明記）。
ルートビルド green・
ktfmtCheck通過済み。🤖 Generated with Claude Code