ライブラリのドキュメントをホストするまで

てべすてん

バージョンごとにv1は/v1, v2は/v2みたいにしたい。

てべすてん

gh-pages-multiが良さそう？

ブランチの管理を任せることでいい感じにしてくれるっぽい。

yarn gh-pages-multi deploy -s docs -t v0.0.0 -b gh-pages

-s ... ドキュメントのベースディレクトリ
-t ... タグ。このタグがデプロイした時のURLのパスの先頭になる
-b ... 管理を任せるブランチ。このブランチはライブラリ側で管理されるので基本的には手動で触らない方がよさそう。

てべすてん

latestも自分で呼ばないと更新してくれないっぽい。
-tで指定するタグが latest になるだけ

てべすてん

issueにも上がってたがやっぱり別ブランチで管理するのがよさそう

@briantist Yoann が言ったように、インクリメンタルデプロイは今のところ GitHub Pages では予定されていない機能です。過去にはこのような考え方もありましたが、悪意のある人たちにセキュリティの脆弱性を悪用される原因となっていました。

推奨される回避策としては、"ビルド" ワークフローをデフォルトのブランチ (たとえば main) で動作させ、ビルドした変更を二番目のブランチ/タグ/リリースにプッシュして公開サイトのアセットを維持することをお勧めします。必要なアセットのマージは、あなた次第です。最新のコードのビルドを実行する前か後に、以前に公開したアセットをビルド・ワークスペースに取り込むことができます。🤷🏻‍♂️
https://github.com/actions/deploy-pages/issues/73#issuecomment-1477234353

こいつがめっちゃ強い

こたろーさんに敬礼🫡

てべすてん

これだけ

permissions:
  contents: write

jobs:
  release-documents:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout sources
        uses: actions/checkout@v4
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs-dokka
          destination_dir: ${{ github.event.release.tag_name }}
          keep_files: true

てべすてん

中身的には

gh-pages ブランチ(変更可) にファイルをコピーした後 keep_files == false なら対象ディレクトリ以外を削除してるっぽい。