main.yml

# This is a basic workflow to help you get started with Actions

name: CI

# Controls when the action will run. 
on:
  # Triggers the workflow on push or pull request events but only for the dev branch
  push:
    branches: [ dev ]
  pull_request:
    branches: [ dev ]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# 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_docs:
    # 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/cache@v2
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip-${{ hashFiles('**/dev-requirements.txt', '**/setup.py') }}
          restore-keys: |
            ${{ runner.os }}-pip-
      
      # Install dependencies
      - name: Install dependencies
        run: |
          pip3 install -e .
          pip3 install -r dev-requirements.txt
      
      - name: Install pandoc
        run: |
          sudo apt-get install pandoc

      - name: Create empty docs directory
        run: |
          pwd -P
          mkdir -p docs/_build/html

      - name: Clone the directory
        uses: actions/checkout@v2
        with:
          ref: docs
          path: 'docs/_build/html'
          
      - name: Clean tree
        run: |
          cd docs/_build/html
          git rm -r *
          
      # Build docs
      - name: Build docs
        run: |
          cd docs
          make html
          
      - name: Add docs
        run: |
          cd docs/_build/html
          git add -A .
          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
          git config --local user.name "github-actions[bot]"
          git diff-index --quiet HEAD || git commit -m "Update docs"

      - name: Push changes to new docs branch
        uses: ad-m/github-push-action@master
        with:
          github_token: ${{ secrets.DOCS_TOKEN }}
          branch: docs
          directory: docs/_build/html
          force: true

  test:
    # 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/cache@v2
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip-${{ hashFiles('**/dev-requirements.txt', '**/setup.py') }}
          restore-keys: |
            ${{ runner.os }}-pip-
      
      # Install dependencies
      - name: Install dependencies
        run: |
          pip3 install -e .
          pip3 install -r dev-requirements.txt
          pip3 install pytest
      
      - name: Test with pytest
        run: |
          pytest tests --doctest-modules --junitxml=junit/test-results.xml --cov=cij --cov-report=xml --cov-report=html

      - uses: codecov/codecov-action@v1
        with:
          token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
          files: ./coverage.xml # optional
          flags: unittests # optional
          fail_ci_if_error: true # optional (default = false)
          verbose: true # optional (default = false)

      - name: Publish Test Report
        uses: mikepenz/action-junit-report@v2
        with:
          report_paths: 'junit/test-results.xml'
          github_token: ${{ secrets.GITHUB_TOKEN }}