github pagesでカスタムドメインがpublishの度に外れて困っていたのをなおしたやつ

状況

github workfrowsを利用して別のbranchにpushすると、github Pagesのカスタムドメインが外れてしまっていた。

環境

1. ビルドコンテンツはdocs下に出力するようにしている
2. publishDirは./docsを指定している
3. CNAMEファイルは./CNAMEにあり、ビルド対象でないためdocs下には出力されない

原因

• たとえ過去に./docs下へCNAMEファイルを追加していても、force pushしているのでビルド時に上書かれて消えてしまっていた

対処

jobs:
  Build:
      - name: Generate pages
        run: |
          hugo -D #ここでビルド
          cp ./CNAME ./docs #CNAMEファイルをコピー
      
      - name: Deploy gh-pages
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs
          publish_branch: gh-pages