Browse Source

Moved doc generation to GitHub Actions

4.0.0-beta
Anairkoen Schno 4 years ago
parent
commit
5560c00162
3 changed files with 101 additions and 1 deletions
  1. +54
    -0
      .github/workflows/docs.yml
  2. +46
    -0
      .github/workflows/tag_docs.yml
  3. +1
    -1
      appveyor.yml

+ 54
- 0
.github/workflows/docs.yml View File

@ -0,0 +1,54 @@
name: Routine Docs
on:
push:
branches-ignore:
- gh-pages
jobs:
docs:
name: Generate docs
runs-on: windows-latest
steps:
- name: Configure git
run: git config --global core.autocrlf true
- name: Checkout branch
uses: actions/checkout@v2
- name: Checkout submodules
run: git submodule update --init --recursive
- name: Locate MSBuild
uses: warrenbuckley/Setup-MSBuild@v1
- name: Setup Nuget
uses: warrenbuckley/Setup-Nuget@v1
- name: Nuget Restore
run: nuget restore
- name: Install DocFX
uses: crazy-max/ghaction-chocolatey@v1
with:
args: install docfx -y
- name: Build docs
env:
SOURCE_COMMIT: ${{ github.sha }}
shell: powershell
working-directory: ./docs
run: |
Add-Content link_branch.json "{`"_gitContribute`":{`"sourceBranch`":`"$env:SOURCE_COMMIT`",`"apiSpecFolder`":`"docs/override`"}}"
powershell .\build.ps1
if ($lastexitcode -ne 0){
throw [System.Exception] "docfx build failed with exit code $lastexitcode."
}
- name: Publish master site to GitHub pages
uses: seanmiddleditch/gha-publish-to-git@master
with:
branch: gh-pages
github-token: ${{ secrets.pagesCommitToken }}
source_folder: docs/_site
if: github.ref == 'master'
- name: Publish branch site to GitHub pages
uses: seanmiddleditch/gha-publish-to-git@master
with:
branch: gh-pages
github-token: ${{ secrets.pagesCommitToken }}
source_folder: docs/_site
target_folder: branch/${{ github.ref }}
if: github.ref != 'master'

+ 46
- 0
.github/workflows/tag_docs.yml View File

@ -0,0 +1,46 @@
name: Tag Docs
on:
release:
types: [created]
jobs:
docs:
name: Generate docs
runs-on: windows-latest
steps:
- name: Configure git
run: git config --global core.autocrlf true
- name: Checkout branch
uses: actions/checkout@v2
- name: Checkout submodules
run: git submodule update --init --recursive
- name: Locate MSBuild
uses: warrenbuckley/Setup-MSBuild@v1
- name: Setup Nuget
uses: warrenbuckley/Setup-Nuget@v1
- name: Nuget Restore
run: nuget restore
- name: Install DocFX
uses: crazy-max/ghaction-chocolatey@v1
with:
args: install docfx -y
- name: Build docs
env:
SOURCE_COMMIT: ${{ github.sha }}
shell: powershell
working-directory: ./docs
run: |
Add-Content link_branch.json "{`"_gitContribute`":{`"sourceBranch`":`"$env:SOURCE_COMMIT`",`"apiSpecFolder`":`"docs/override`"}}"
powershell .\build.ps1
if ($lastexitcode -ne 0){
throw [System.Exception] "docfx build failed with exit code $lastexitcode."
}
- name: Publish tag site to GitHub pages
uses: seanmiddleditch/gha-publish-to-git@master
with:
branch: gh-pages
github-token: ${{ secrets.pagesCommitToken }}
source_folder: docs/_site
target_folder: tags/${{ github.ref }}

+ 1
- 1
appveyor.yml View File

@ -9,7 +9,7 @@ environment:
BuildForBeatSaber: 'false'
matrix:
- BUILD_DOC: 'no'
- BUILD_DOC: 'yes'
#- BUILD_DOC: 'yes'
pull_requests:
do_not_increment_build_number: true


Loading…
Cancel
Save