Merge pull request #5 from ananthb/main #6
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |