check_and_generate_docs.yml

name: Check and generate documentations

on:
  push:

jobs:
  check:
    name: Check if generating is necessary
    outputs:
      run_job: ${{ steps.check_files.outputs.run_job }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2
        with:
          fetch-depth: 3

      - name: Check modified files
        id: check_files
        run: |
          echo "=============== List modified files ==============="
          git diff --name-only HEAD^ HEAD

          echo "========== Check paths of modified files =========="
          git diff --name-only HEAD^ HEAD > files.txt
          while IFS= read -r file
          do
            echo $file
            if [[ $file != docs/* ]]; then
              echo "This modified file is not under the 'docs' folder."
              echo "::set-output name=run_job::false"
              break
            else
              echo "::set-output name=run_job::true"
            fi
          done < files.txt

  update:
    name: Update documentation
    runs-on: ubuntu-latest
    needs: check
    if: needs.check.outputs.run_job == 'true'
    steps:
      - uses: actions/checkout@v2
        with:
          persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal access token.
          fetch-depth: 1 # otherwise, there would be errors pushing refs to the destination repository.
      - uses: actions/setup-python@v3
        with:
          python-version: "3.9"
          cache: "pip"
      - name: Updating scripts table in README.md
        run: |
          cd "docs/templates/" && pip install -r requirements.txt && python update_scripts_table.py
      - name: Commit files
        run: |
          git config --local user.email "92151357+kalagiri-bot@users.noreply.github.com"
          git config --local user.name "Krishna Alagiri [bot]"
          git commit -m "[skip ci] Updating documentation" -a
      - name: Push changes
        uses: ad-m/github-push-action@master
        with:
          github_token: ${{ secrets.GH_TOKEN }}
          branch: ${{ github.ref }}