From eb0d6ca2468db387239437e59ceebf896afcc808 Mon Sep 17 00:00:00 2001 From: Takanori Hirano Date: Thu, 21 Aug 2025 12:01:32 +0000 Subject: [PATCH 1/2] ci: add GitHub Pages deployment and improve docs workflow - Add docs-check job to check.yaml with working-directory defaults - Create docs.yaml workflow for building and deploying to GitHub Pages - Configure proper permissions and concurrency for Pages deployment --- .github/workflows/check.yaml | 23 +++++++++++++++++ .github/workflows/docs.yaml | 50 ++++++++++++++++++++++++++++++++++++ 2 files changed, 73 insertions(+) create mode 100644 .github/workflows/docs.yaml diff --git a/.github/workflows/check.yaml b/.github/workflows/check.yaml index f784e28..55197a5 100644 --- a/.github/workflows/check.yaml +++ b/.github/workflows/check.yaml @@ -30,3 +30,26 @@ jobs: - uses: dominikh/staticcheck-action@v1.4.0 with: install-go: false + + docs-check: + runs-on: ubuntu-latest + defaults: + run: + working-directory: docs + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up Node.js + uses: actions/setup-node@v4 + with: + node-version: "24" + cache: "npm" + cache-dependency-path: docs/package-lock.json + + - name: Install docs dependencies + run: npm ci + + - name: Lint documentation + run: npm run lint diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml new file mode 100644 index 0000000..817e860 --- /dev/null +++ b/.github/workflows/docs.yaml @@ -0,0 +1,50 @@ +name: Deploy Docs to GitHub Pages + +on: + push: + branches: + - main + pull_request: + branches: + - main + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + build: + runs-on: ubuntu-latest + defaults: + run: + working-directory: docs + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up Node.js + uses: actions/setup-node@v4 + with: + node-version: "24" + cache: "npm" + cache-dependency-path: docs/package-lock.json + + - name: Install dependencies + run: npm ci + + - name: Build documentation + run: npm run build + + - name: Setup Pages + uses: actions/configure-pages@v5 + + - name: Upload to GitHub Pages + uses: actions/upload-pages-artifact@v3 + with: + path: docs/build From 43d05216ac2cdbaa25e89132c84c92b84d2b8852 Mon Sep 17 00:00:00 2001 From: Takanori Hirano Date: Thu, 21 Aug 2025 21:03:18 +0900 Subject: [PATCH 2/2] Update .github/workflows/docs.yaml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .github/workflows/docs.yaml | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 817e860..31ea392 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -48,3 +48,14 @@ jobs: uses: actions/upload-pages-artifact@v3 with: path: docs/build + + deploy: + needs: build + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4