Ensure documentation pull requests build (#23908)

This commit is contained in:
Joel Challis 2024-06-13 02:59:37 +01:00 committed by GitHub
parent 7247039742
commit fa40356250
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 9 additions and 28 deletions

View File

@ -7,7 +7,6 @@ on:
push: push:
branches: branches:
- master - master
- vitepress
paths: paths:
- 'builddefs/docsgen/**' - 'builddefs/docsgen/**'
- 'tmk_core/**' - 'tmk_core/**'
@ -15,6 +14,11 @@ on:
- 'platforms/**' - 'platforms/**'
- 'docs/**' - 'docs/**'
- '.github/workflows/docs.yml' - '.github/workflows/docs.yml'
pull_request:
paths:
- 'builddefs/docsgen/**'
- 'docs/**'
- '.github/workflows/docs.yml'
defaults: defaults:
run: run:
@ -25,9 +29,6 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
container: ghcr.io/qmk/qmk_cli container: ghcr.io/qmk/qmk_cli
# protect against those who develop with their fork on master
if: github.repository == 'qmk/qmk_firmware' || (github.repository == 'tzarc/qmk_firmware' && github.ref == 'refs/heads/vitepress')
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
with: with:
@ -35,10 +36,10 @@ jobs:
- name: Install dependencies - name: Install dependencies
run: | run: |
apt-get update && apt-get install -y rsync doxygen curl apt-get update && apt-get install -y rsync doxygen
# install nvm # install nvm
touch $HOME/.bashrc touch $HOME/.bashrc
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
- name: Install node - name: Install node
run: | run: |
@ -46,29 +47,15 @@ jobs:
nvm install 20 nvm install 20
nvm use 20 nvm use 20
corepack enable corepack enable
npm install -g moxygen
- name: Build docs - name: Build docs
run: | run: |
source $HOME/.bashrc source $HOME/.bashrc
nvm use 20 nvm use 20
qmk --verbose generate-docs 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 - name: Deploy
if: github.repository == 'qmk/qmk_firmware' if: ${{ github.event_name == 'push' && github.repository == 'qmk/qmk_firmware' }}
uses: JamesIves/github-pages-deploy-action@v4.6.1 uses: JamesIves/github-pages-deploy-action@v4.6.1
with: with:
token: ${{ secrets.GITHUB_TOKEN }} token: ${{ secrets.GITHUB_TOKEN }}
@ -76,10 +63,3 @@ jobs:
folder: .build/docs folder: .build/docs
git-config-name: QMK Bot git-config-name: QMK Bot
git-config-email: hello@qmk.fm git-config-email: hello@qmk.fm
- name: Deploy
if: github.repository == 'tzarc/qmk_firmware'
uses: JamesIves/github-pages-deploy-action@v4.6.1
with:
branch: gh-pages
folder: .build/docs

0
docs/public/.nojekyll Normal file
View File

1
docs/public/CNAME Normal file
View File

@ -0,0 +1 @@
docs.qmk.fm