aboutsummaryrefslogtreecommitdiff
path: root/.github/workflows/docs.yml
diff options
context:
space:
mode:
authorNick Brassel <[email protected]>2024-05-30 12:00:41 +1000
committerGitHub <[email protected]>2024-05-30 12:00:41 +1000
commit6ef97172889ccd5db376b2a9f8825489e24fdac4 (patch)
tree334e3bf41c8554d4bee73a140822f95f60eb64e9 /.github/workflows/docs.yml
parent395766657ff98a4b1fd0dcba5917557f8acbb9e4 (diff)
downloadqmk_firmware-6ef97172889ccd5db376b2a9f8825489e24fdac4.tar.gz
qmk_firmware-6ef97172889ccd5db376b2a9f8825489e24fdac4.zip
Vitepress conversion of docs. (#23795)
Diffstat (limited to '.github/workflows/docs.yml')
-rw-r--r--.github/workflows/docs.yml53
1 files changed, 46 insertions, 7 deletions
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index a00e6616a6..25311019c6 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -7,20 +7,26 @@ on:
push:
branches:
- master
+ - vitepress
paths:
+ - 'builddefs/docsgen/**'
- 'tmk_core/**'
- 'quantum/**'
- 'platforms/**'
- 'docs/**'
- '.github/workflows/docs.yml'
+defaults:
+ run:
+ shell: bash
+
jobs:
generate:
runs-on: ubuntu-latest
container: ghcr.io/qmk/qmk_cli
# protect against those who develop with their fork on master
- if: github.repository == 'qmk/qmk_firmware'
+ if: github.repository == 'qmk/qmk_firmware' || (github.repository == 'tzarc/qmk_firmware' && github.ref == 'refs/heads/vitepress')
steps:
- uses: actions/checkout@v4
@@ -29,18 +35,51 @@ jobs:
- name: Install dependencies
run: |
- apt-get update && apt-get install -y rsync nodejs npm doxygen
+ apt-get update && apt-get install -y rsync doxygen curl
+ # install nvm
+ touch $HOME/.bashrc
+ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
+
+ - name: Install node
+ run: |
+ source $HOME/.bashrc
+ nvm install 20
+ nvm use 20
+ corepack enable
npm install -g moxygen
- name: Build docs
run: |
+ source $HOME/.bashrc
+ nvm use 20
qmk --verbose generate-docs
+ touch '.build/docs/.nojekyll'
+
+ - name: Set CNAME
+ if: github.repository == 'qmk/qmk_firmware'
+ run: |
+ # Override target CNAME
+ echo 'docs.qmk.fm' > .build/docs/CNAME
+
+ - name: Override CNAME
+ if: github.repository == 'tzarc/qmk_firmware'
+ run: |
+ # Temporarily override target CNAME during development
+ echo 'vitepress.qmk.fm' > .build/docs/CNAME
+
+ - name: Deploy
+ if: github.repository == 'qmk/qmk_firmware'
+ uses: JamesIves/[email protected]
+ with:
+ token: ${{ secrets.GITHUB_TOKEN }}
+ branch: gh-pages
+ folder: .build/docs
+ git-config-name: QMK Bot
+ git-config-email: [email protected]
- name: Deploy
+ if: github.repository == 'tzarc/qmk_firmware'
uses: JamesIves/[email protected]
with:
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- BASE_BRANCH: master
- BRANCH: gh-pages
- FOLDER: .build/docs
- GIT_CONFIG_EMAIL: [email protected]
+ branch: gh-pages
+ folder: .build/docs