diff options
| author | Nick Brassel <nick@tzarc.org> | 2024-05-30 12:00:41 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-30 12:00:41 +1000 |
| commit | 6ef97172889ccd5db376b2a9f8825489e24fdac4 (patch) | |
| tree | 334e3bf41c8554d4bee73a140822f95f60eb64e9 /.github/workflows | |
| parent | 395766657ff98a4b1fd0dcba5917557f8acbb9e4 (diff) | |
Vitepress conversion of docs. (#23795)
Diffstat (limited to '.github/workflows')
| -rw-r--r-- | .github/workflows/docs.yml | 53 |
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: | |||
| 7 | push: | 7 | push: |
| 8 | branches: | 8 | branches: |
| 9 | - master | 9 | - master |
| 10 | - vitepress | ||
| 10 | paths: | 11 | paths: |
| 12 | - 'builddefs/docsgen/**' | ||
| 11 | - 'tmk_core/**' | 13 | - 'tmk_core/**' |
| 12 | - 'quantum/**' | 14 | - 'quantum/**' |
| 13 | - 'platforms/**' | 15 | - 'platforms/**' |
| 14 | - 'docs/**' | 16 | - 'docs/**' |
| 15 | - '.github/workflows/docs.yml' | 17 | - '.github/workflows/docs.yml' |
| 16 | 18 | ||
| 19 | defaults: | ||
| 20 | run: | ||
| 21 | shell: bash | ||
| 22 | |||
| 17 | jobs: | 23 | jobs: |
| 18 | generate: | 24 | generate: |
| 19 | runs-on: ubuntu-latest | 25 | runs-on: ubuntu-latest |
| 20 | container: ghcr.io/qmk/qmk_cli | 26 | container: ghcr.io/qmk/qmk_cli |
| 21 | 27 | ||
| 22 | # protect against those who develop with their fork on master | 28 | # protect against those who develop with their fork on master |
| 23 | if: github.repository == 'qmk/qmk_firmware' | 29 | if: github.repository == 'qmk/qmk_firmware' || (github.repository == 'tzarc/qmk_firmware' && github.ref == 'refs/heads/vitepress') |
| 24 | 30 | ||
| 25 | steps: | 31 | steps: |
| 26 | - uses: actions/checkout@v4 | 32 | - uses: actions/checkout@v4 |
| @@ -29,18 +35,51 @@ jobs: | |||
| 29 | 35 | ||
| 30 | - name: Install dependencies | 36 | - name: Install dependencies |
| 31 | run: | | 37 | run: | |
| 32 | apt-get update && apt-get install -y rsync nodejs npm doxygen | 38 | apt-get update && apt-get install -y rsync doxygen curl |
| 39 | # install nvm | ||
| 40 | touch $HOME/.bashrc | ||
| 41 | curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash | ||
| 42 | |||
| 43 | - name: Install node | ||
| 44 | run: | | ||
| 45 | source $HOME/.bashrc | ||
| 46 | nvm install 20 | ||
| 47 | nvm use 20 | ||
| 48 | corepack enable | ||
| 33 | npm install -g moxygen | 49 | npm install -g moxygen |
| 34 | 50 | ||
| 35 | - name: Build docs | 51 | - name: Build docs |
| 36 | run: | | 52 | run: | |
| 53 | source $HOME/.bashrc | ||
| 54 | nvm use 20 | ||
| 37 | qmk --verbose generate-docs | 55 | qmk --verbose generate-docs |
| 56 | touch '.build/docs/.nojekyll' | ||
| 57 | |||
| 58 | - name: Set CNAME | ||
| 59 | if: github.repository == 'qmk/qmk_firmware' | ||
| 60 | run: | | ||
| 61 | # Override target CNAME | ||
| 62 | echo 'docs.qmk.fm' > .build/docs/CNAME | ||
| 63 | |||
| 64 | - name: Override CNAME | ||
| 65 | if: github.repository == 'tzarc/qmk_firmware' | ||
| 66 | run: | | ||
| 67 | # Temporarily override target CNAME during development | ||
| 68 | echo 'vitepress.qmk.fm' > .build/docs/CNAME | ||
| 69 | |||
| 70 | - name: Deploy | ||
| 71 | if: github.repository == 'qmk/qmk_firmware' | ||
| 72 | uses: JamesIves/github-pages-deploy-action@v4.6.1 | ||
| 73 | with: | ||
| 74 | token: ${{ secrets.GITHUB_TOKEN }} | ||
| 75 | branch: gh-pages | ||
| 76 | folder: .build/docs | ||
| 77 | git-config-name: QMK Bot | ||
| 78 | git-config-email: hello@qmk.fm | ||
| 38 | 79 | ||
| 39 | - name: Deploy | 80 | - name: Deploy |
| 81 | if: github.repository == 'tzarc/qmk_firmware' | ||
| 40 | uses: JamesIves/github-pages-deploy-action@v4.6.1 | 82 | uses: JamesIves/github-pages-deploy-action@v4.6.1 |
| 41 | with: | 83 | with: |
| 42 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | 84 | branch: gh-pages |
| 43 | BASE_BRANCH: master | 85 | folder: .build/docs |
| 44 | BRANCH: gh-pages | ||
| 45 | FOLDER: .build/docs | ||
| 46 | GIT_CONFIG_EMAIL: hello@qmk.fm | ||
