Small README update #441
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Build and Publish Docs | |
on: | |
push: | |
branches: | |
- master | |
pull_request: | |
branches: | |
- master | |
env: | |
EXILED_REFERENCES_URL: https://www.exiled.host/build_deps/References.zip | |
EXILED_REFERENCES_PATH: ${{ github.workspace }}/References | |
jobs: | |
build_and_publish_docs: | |
runs-on: windows-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v2.3.4 | |
- name: Setup .NET Core SDK | |
uses: actions/setup-dotnet@v1.7.2 | |
- name: Setup Nuget | |
uses: iRebbok/setup-nuget@master | |
- name: Get references | |
shell: pwsh | |
run: | | |
Invoke-WebRequest -Uri https://exiled.host/build_deps/References.zip -OutFile ${{ github.workspace }}/References.zip | |
Expand-Archive -Path References.zip -DestinationPath ${{ env.EXILED_REFERENCES_PATH }} | |
- name: Download DocFX | |
uses: crazy-max/ghaction-chocolatey@v1 | |
with: | |
args: install docfx --pre | |
- name: Run DocFX | |
env: | |
EXILED_REFERENCES: ${{ env.EXILED_REFERENCES_PATH }} | |
run: docfx docfx.json; docfx docfx.json | |
- name: Deploy to GitHub Pages | |
if: github.event_name == 'push' && success() #Only publishes on push to master to avoid docs mishaps | |
uses: crazy-max/ghaction-github-pages@v2 | |
with: | |
target_branch: gh-pages | |
build_dir: _site | |
keep_history: true | |
jekyll: false | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |