Github ActionsでのJSDoc自動化の設定

リポジトリは次のようになっているとする。

• リポジトリ名switchbot-handler.js（.jsまでリポジトリ名）
• リポジトリ直下にindex.jsやREADME.mdが入っている。
• JSDocの設定ファイルはdocsフォルダにいれてある。（下記１番のとおり）

やること

1. ローカルで必要ファイルを作成しておく。
   ./docsと./docs/config.jsonを用意しておく

2. 該当リポジトリ > Setting > Pages > Source
   [Deploy from a Branch] > [Github Actions]

3. GitHub Pages Jekyll
   [Configure]
   [Commit changes...]
   [Commit chages]

ここでできたファイルを下記のように修正。リポジトリ名などは自分のものにする。

# Sample workflow for building and deploying a Jekyll site to GitHub Pages
name: Deploy Jekyll with GitHub Pages dependencies preinstalled

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["main"]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  # Build job
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Setup Pages
        uses: actions/configure-pages@v3
      - name: dir
        run: |
          dir # confirm
      - name: Build with Jekyll
        uses: actions/jekyll-build-pages@v1
        with:
          source: ./
          destination: ./_site
      - name: Build JSDoc
        uses: andstor/jsdoc-action@v1
        with:
          source_dir: ./
          output_dir: ./docs/jsdoc
          config_file: ./docs/config.json
          template: minami
          front_page: README.md
      - uses: actions/upload-pages-artifact@v1
        with:
          path: ./docs/jsdoc

  # Deployment job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2

1. URLは下記のような感じ。もちろんActionsを見ながら、実行結果が成功したか確認する。
   https://hiroshi-sugimura.github.io/switchbot-handler.js/
2. URLをREADME.mdにいれておく