From 0b0bc49b22cf9297c261e98e47bf4eee9017bf9d Mon Sep 17 00:00:00 2001 From: Kirbyrawr Date: Mon, 4 May 2020 23:02:29 +0200 Subject: [PATCH 1/2] Added workflow to update the documentation automatically when a pr to master is merged or a push to master was done. --- .github/workflows/update-documentation.yml | 42 ++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 .github/workflows/update-documentation.yml diff --git a/.github/workflows/update-documentation.yml b/.github/workflows/update-documentation.yml new file mode 100644 index 000000000..44b75ec83 --- /dev/null +++ b/.github/workflows/update-documentation.yml @@ -0,0 +1,42 @@ +# 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 or pull request +# events but only for the master branch +on: + push: + branches: [ master ] + pull_request: + 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 From c04bb3386627a483a3289afcfa7466201a1ab588 Mon Sep 17 00:00:00 2001 From: Kirbyrawr Date: Mon, 4 May 2020 23:07:15 +0200 Subject: [PATCH 2/2] Update update-documentation.yml --- .github/workflows/update-documentation.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/workflows/update-documentation.yml b/.github/workflows/update-documentation.yml index 44b75ec83..1df9983dc 100644 --- a/.github/workflows/update-documentation.yml +++ b/.github/workflows/update-documentation.yml @@ -2,13 +2,11 @@ name: Update Documentation -# Controls when the action will run. Triggers the workflow on push or pull request +# Controls when the action will run. Triggers the workflow on push # events but only for the master branch on: push: branches: [ master ] - pull_request: - branches: [ master ] # A workflow run is made up of one or more jobs that can run sequentially or in parallel jobs: