diff --git a/.github/workflows/update-documentation.yml b/.github/workflows/update-documentation.yml new file mode 100644 index 000000000..1df9983dc --- /dev/null +++ b/.github/workflows/update-documentation.yml @@ -0,0 +1,40 @@ +# This is a basic workflow to help you get started with Actions + +name: Update Documentation + +# Controls when the action will run. Triggers the workflow on push +# events but only for the master branch +on: + push: + branches: [ master ] + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + # This workflow contains a single job called "build" + build: + # The type of runner that the job will run on + runs-on: ubuntu-latest + + # Steps represent a sequence of tasks that will be executed as part of the job + steps: + # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it + - uses: actions/checkout@v2 + + # Build metadata documentation using DocFX + - name: Build Documentation Metadata + uses: Kirbyrawr/docfx-action@master + with: + args: metadata ./docfx/docfx.json + + # Build documentation using DocFX + - name: Build Documentation + uses: Kirbyrawr/docfx-action@master + with: + args: build ./docfx/docfx.json + + # Publish generated site using GitHub Pages + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./docfx/_site