build-deploy-doc.yml

name: Build and Deploy 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:
  # Install required libraries
  build-and-deploy-documentation:
    # 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
      - uses: actions/setup-python@v1
        with:
          python-version: '3.7' # Version range or exact version of a Python version to use, using SemVer's version range syntax
          architecture: 'x64' # optional x64 or x86. Defaults to x64 if not specified

      # Installs and updates bikeshed
      - name: Install bikeshed
        run: |
          pushd /tmp
          git clone https://github.com/tabatkins/bikeshed.git
          pip install --editable $PWD/bikeshed
          bikeshed update
          popd

      # Builds the documentation with the script
      - name: Build documentation
        run: ./scripts/build-doc.sh

      # Removes the gitignore file
      - name: Remove gitignore
        run: rm .gitignore

      # Deploy
      - name: Deploy
        uses: JamesIves/github-pages-deploy-action@releases/v3
        with:
          ACCESS_TOKEN: ${{ secrets.WESOBOT_ACCESS_TOKEN }}
          BRANCH: gh-pages # The branch the action should deploy to.
          FOLDER: doc # The folder the action should deploy.