aboutsummaryrefslogtreecommitdiff
path: root/.github/workflows/docs.yml
diff options
context:
space:
mode:
authorJoel Challis <[email protected]>2024-06-13 02:59:37 +0100
committerGitHub <[email protected]>2024-06-13 02:59:37 +0100
commitfa403562500e1229256ea355d36a8bf4c7967021 (patch)
tree9a640384bab6c53de83eef4859f921efb08bfe0e /.github/workflows/docs.yml
parent7247039742fb81cbf1e443c23a8070afb5961762 (diff)
downloadqmk_firmware-fa403562500e1229256ea355d36a8bf4c7967021.tar.gz
qmk_firmware-fa403562500e1229256ea355d36a8bf4c7967021.zip
Ensure documentation pull requests build (#23908)
Diffstat (limited to '.github/workflows/docs.yml')
-rw-r--r--.github/workflows/docs.yml36
1 files changed, 8 insertions, 28 deletions
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 25311019c6..0fdd2c7b37 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -7,7 +7,6 @@ on:
push:
branches:
- master
- - vitepress
paths:
- 'builddefs/docsgen/**'
- 'tmk_core/**'
@@ -15,6 +14,11 @@ on:
- 'platforms/**'
- 'docs/**'
- '.github/workflows/docs.yml'
+ pull_request:
+ paths:
+ - 'builddefs/docsgen/**'
+ - 'docs/**'
+ - '.github/workflows/docs.yml'
defaults:
run:
@@ -25,9 +29,6 @@ jobs:
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' || (github.repository == 'tzarc/qmk_firmware' && github.ref == 'refs/heads/vitepress')
-
steps:
- uses: actions/checkout@v4
with:
@@ -35,10 +36,10 @@ jobs:
- name: Install dependencies
run: |
- apt-get update && apt-get install -y rsync doxygen curl
+ apt-get update && apt-get install -y rsync doxygen
# install nvm
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
run: |
@@ -46,29 +47,15 @@ jobs:
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'
+ if: ${{ github.event_name == 'push' && github.repository == 'qmk/qmk_firmware' }}
uses: JamesIves/[email protected]
with:
token: ${{ secrets.GITHUB_TOKEN }}
@@ -76,10 +63,3 @@ jobs:
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:
- branch: gh-pages
- folder: .build/docs