Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions .github/workflows/publish-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: publish docs

on:
push:
branches:
- main
tags:
- v3.*

permissions:
contents: read

jobs:
test-docs:
name: test-docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: stable

- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: latest

- name: Set PATH
run: echo "${GITHUB_WORKSPACE}/.local/bin" >>"${GITHUB_PATH}"

- run: make ensure-gfmrun

- run: make gfmrun
env:
FLAGS: --walk docs/v3/

- run: make diffcheck

publish:
permissions:
contents: write
if: startswith(github.ref, 'refs/tags/')
name: publish
needs: [test-docs]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0

- run: make ensure-mkdocs
env:
FLAGS: --upgrade-pip

- run: make set-mkdocs-remote
env:
MKDOCS_REMOTE_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- run: make deploy-mkdocs

49 changes: 0 additions & 49 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,52 +58,3 @@ jobs:
token: ${{ secrets.CODECOV_TOKEN }}
fail_ci_if_error: true
verbose: true

test-docs:
name: test-docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: stable

- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: latest

- name: Set PATH
run: echo "${GITHUB_WORKSPACE}/.local/bin" >>"${GITHUB_PATH}"

- run: make ensure-gfmrun

- run: make gfmrun
env:
FLAGS: --walk docs/v3/

- run: make diffcheck

publish:
permissions:
contents: write
if: startswith(github.ref, 'refs/tags/')
name: publish
needs: [test-docs]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0

- run: make ensure-mkdocs
env:
FLAGS: --upgrade-pip

- run: make set-mkdocs-remote
env:
MKDOCS_REMOTE_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- run: make deploy-mkdocs
Loading