From b70c846f409275518698bfd6b9e8717b97c8070c Mon Sep 17 00:00:00 2001 From: akaranjkar-qu <41927856+akaranjkar-qu@users.noreply.github.com> Date: Tue, 17 Mar 2020 21:54:48 -0700 Subject: [PATCH] Create github action to generate documentation (#31) --- .github/workflows/generate_docs.yml | 43 +++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 .github/workflows/generate_docs.yml diff --git a/.github/workflows/generate_docs.yml b/.github/workflows/generate_docs.yml new file mode 100644 index 0000000..91554e9 --- /dev/null +++ b/.github/workflows/generate_docs.yml @@ -0,0 +1,43 @@ +# Github actions workflow to generate documentation + +name: Generate documentation and update readme + +# Trigger the workflow on push event for master branch +# or pull request events but only for the master branch with the type closed +on: + push: + branches: [ master ] + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Checkout bootstrap-functions + uses: actions/checkout@v2 + + - name: Checkout shdoc + uses: actions/checkout@v2 + with: + repository: reconquest/shdoc + path: shdoc + + - name: Add shdoc to PATH + run: | + echo "::add-path::$GITHUB_WORKSPACE/shdoc" + echo "$PATH" + + - name: Generate documentation + run: bash generate_docs.sh + + - name: Commit changes + run: | + git config --local user.email "action@github.com" + git config --local user.name "GitHub Action" + git add README.md docs/ + git commit -m "Update documentation" + + - name: Push changes + uses: ad-m/github-push-action@master + with: + github_token: ${{ secrets.GITHUB_TOKEN }}