Skip to content

Commit

Permalink
Merge pull request #2018 from dearchap/add_new_publish_docs_workflow
Browse files Browse the repository at this point in the history
Feat: Add new workflow for publish docs
  • Loading branch information
dearchap authored Nov 29, 2024
2 parents 824c4ee + f05e837 commit 5bb1617
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 49 deletions.
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

0 comments on commit 5bb1617

Please sign in to comment.