GitHub Actionsを使ってGithub PagesにOpen APIのドキュメントを公開したメモ

- .github
  - workflows
    - gh-pages.yml      ... Gihub Actions記述
- src ... ソースコード
- docs
  - index.html          ... 各ドキュメントへのリンクを張るのみのHTML
- internals             ... 内部使用ドキュメントツールを入れるディレクトリ
  - api-schema          ... OpenAPIを記述

name: github pages

on:
  push:
    branches:
      - docs  # Set a branch name to trigger deployment

jobs:
  deploy:
    runs-on: ubuntu-20.04
    steps:
      - uses: actions/checkout@v2

      - name: Setup Node
        uses: actions/setup-node@v2
        with:
          node-version: '14'

      - name: OpenAPI Setup
        run: npm ci
        working-directory: ./internals/api-schema

      - name: OpenAPI Make
        run: npm run redoc
        working-directory: ./internals/api-schema


      - name: OpenAPI Move files
        run: |
          mkdir -p ./docs/publish/api-schema
          mv ./internals/api-schema/dist/index.html ./docs/publish/api-schema/

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs