diff options
Diffstat (limited to '.github/workflows/docs.yml')
-rw-r--r-- | .github/workflows/docs.yml | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 000000000..8855d1107 --- /dev/null +++ b/.github/workflows/docs.yml | |||
@@ -0,0 +1,43 @@ | |||
1 | name: Generate Docs | ||
2 | |||
3 | on: | ||
4 | push: | ||
5 | branches: | ||
6 | - master | ||
7 | paths: | ||
8 | - 'tmk_core/**' | ||
9 | - 'quantum/**' | ||
10 | - 'platforms/**' | ||
11 | - 'docs/**' | ||
12 | - '.github/workflows/docs.yml' | ||
13 | |||
14 | jobs: | ||
15 | generate: | ||
16 | runs-on: ubuntu-latest | ||
17 | container: qmkfm/base_container | ||
18 | |||
19 | # protect against those who develop with their fork on master | ||
20 | if: github.repository == 'qmk/qmk_firmware' | ||
21 | |||
22 | steps: | ||
23 | - uses: actions/checkout@v2 | ||
24 | with: | ||
25 | fetch-depth: 1 | ||
26 | |||
27 | - name: Install dependencies | ||
28 | run: | | ||
29 | apt-get update && apt-get install -y rsync nodejs npm doxygen | ||
30 | npm install -g moxygen | ||
31 | |||
32 | - name: Build docs | ||
33 | run: | | ||
34 | qmk --verbose generate-docs | ||
35 | |||
36 | - name: Deploy | ||
37 | uses: JamesIves/github-pages-deploy-action@3.7.1 | ||
38 | with: | ||
39 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
40 | BASE_BRANCH: master | ||
41 | BRANCH: gh-pages | ||
42 | FOLDER: .build/docs | ||
43 | GIT_CONFIG_EMAIL: hello@qmk.fm | ||