cosmonaut/.github/workflows/docs.yml at f18d83e97c2a4649532409d9fc63f25a4ab92c2e · linuskendall/cosmonaut · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
name: Docs

on:
  push:
    branches: [main]
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: pages
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-go@v5
        with:
          go-version-file: go.mod

      - name: Install gomarkdoc
        run: go install github.com/princjef/gomarkdoc/cmd/gomarkdoc@latest

      - name: Generate API docs from godoc
        run: |
          gomarkdoc --output docs/api/codespace.md ./internal/codespace/
          gomarkdoc --output docs/api/config.md ./internal/config/
          gomarkdoc --output docs/api/daemon.md ./internal/daemon/
          gomarkdoc --output docs/api/editor.md ./internal/editor/
          gomarkdoc --output docs/api/history.md ./internal/history/
          gomarkdoc --output docs/api/slug.md ./internal/slug/
          gomarkdoc --output docs/api/sshconfig.md ./internal/sshconfig/
          gomarkdoc --output docs/api/tui.md ./internal/tui/

      - uses: actions/setup-python@v5
        with:
          python-version: '3.x'

      - name: Build docs
        run: |
          pip install mkdocs-material
          mkdocs build --strict

      - uses: actions/upload-pages-artifact@v3
        with:
          path: site

  deploy:
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - id: deployment
        uses: actions/deploy-pages@v4