diff options
| author | Joel Challis <git@zvecr.com> | 2020-11-10 15:00:40 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-10 07:00:40 -0800 |
| commit | aae3b35c0fc363e4a9246e774b714a7a1ef7b6c0 (patch) | |
| tree | 3d9adfd3eea4a72779b82787ed8210a1971832c5 /.github | |
| parent | abf1902ff597e77e910c0fb9a8d132b46f78317b (diff) | |
| download | qmk_firmware-aae3b35c0fc363e4a9246e774b714a7a1ef7b6c0.tar.gz qmk_firmware-aae3b35c0fc363e4a9246e774b714a7a1ef7b6c0.zip | |
CI: Add docs build and deploy workflow (#7448)
* Add docs build and deploy workflow
* Remove old travis docs workflow
* update to cli command
* Tidy up for review
* formatting
* Update to pass style checks
* Update lib/python/qmk/cli/docs.py
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* Review comments - build->generate, use of verbose
* Add docs
* Update to match recent actions
* Run within base_container
* Convert cli to generate-docs
* Convert cli to generate-docs - restore old file
* Convert cli to generate-docs
* Update docs
Co-authored-by: skullydazed <skullydazed@users.noreply.github.com>
Diffstat (limited to '.github')
| -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 | ||
