build.yml

name: CI pipeline

on:
  - push
  - pull_request

jobs:

  lint:
    runs-on: ubuntu-latest
    outputs:
      score: ${{ steps.pylint.outputs.score }}
    steps:
    - uses: actions/checkout@v1
    - name: Set up Python 3.7
      uses: actions/setup-python@v2
      with:
        python-version: "3.7"
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        python -m pip install pylint
    - name: Lint with pylint
      id: pylint
      run: |
        mkdir -p ./build
        pylint backpack --exit-zero --output-format=text | tee build/pylint.txt
        echo ::set-output name=score::$(sed -n 's/^Your code has been rated at \([-0-9.]*\)\/.*/\1/p' build/pylint.txt)
    - name: Upload lint report artifact
      uses: actions/upload-artifact@v2
      with:
        name: lint-report
        path: build

  unittest:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ['3.7']
    outputs:
      coverage: ${{ steps.tox.outputs.coverage }}
    steps:
    - uses: actions/checkout@v1
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v2
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        python -m pip install tox tox-gh-actions
    - name: Test with tox
      id: tox
      run: |
        tox
        echo ::set-output name=coverage::$(jq '.totals.percent_covered' build/coverage.json)
    - name: Upload coverage report artifact
      uses: actions/upload-artifact@v2
      with:
        name: code-coverage-report
        path: build

  docs:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - name: Set up Python 3.7
      uses: actions/setup-python@v2
      with:
        python-version: "3.7"
    - name: Install dependencies
      run: |
        sudo sed -i 's/azure\.//' /etc/apt/sources.list
        sudo apt-get update -y
        sudo apt install -y libunwind-dev
        sudo apt-get install -y  --no-install-recommends libgirepository1.0-dev libgstreamer1.0-dev libgstrtspserver-1.0-dev
        python -m pip install --upgrade pip
        python -m pip install opencv-python boto3 PyGObject python-dotenv
        python -m pip install sphinx sphinx-rtd-theme m2r2
    - name: Generate documentation with Sphinx
      working-directory: ./docs
      run: |
        make html
    - name: Upload documentation artifact
      uses: actions/upload-artifact@v2
      with:
        name: documentation
        path: ./docs/_build/html
    - name: Configure AWS credentials
      uses: aws-actions/configure-aws-credentials@v1
      with:
        aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
        aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
        aws-region: eu-west-1
    - name: Upload artifacts to S3
      run: aws s3 sync ./docs/_build/html s3://github-ci.experiments.neosperience.com/Neosperience/backpack/docs/ --delete --acl public-read

  report:
    needs: [lint, unittest, docs]
    runs-on: ubuntu-latest
    if: ${{ always() }}
    steps:
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        python -m pip install anybadge
        mkdir -p ./build
    - name: Create lint badge
      if: ${{ needs.lint.result == 'success' }}
      run: anybadge --value="${{ needs.lint.outputs.score }}" --file="build/pylint.svg" pylint
    - name: Create lint n/a badge
      if: ${{ needs.lint.result != 'success' }}
      run: anybadge --label="pylint" --value="n/a" --file="build/pylint.svg" --color gray
    - name: Create coverage badge
      if: ${{ needs.unittest.result == 'success' }}
      run: anybadge --label "coverage" --value=$(printf "%.1f%%" ${{ needs.unittest.outputs.coverage }}) --file="build/coverage.svg"
    - name: Create coverage n/a badge
      if: ${{ needs.unittest.result != 'success' }}
      run: anybadge --label="coverage" --value="n/a" --file="build/coverage.svg" --color gray
    - name: Create pipeline success badge
      if: ${{ needs.unittest.result == 'success' && needs.lint.result == 'success' }}
      run: anybadge --label="pipeline" --value="passing" --file="build/pipeline.svg" passing=green failing=red
    - name: Create pipeline failure badge
      if: ${{ needs.unittest.result != 'success' || needs.lint.result != 'success' }}
      run: anybadge --label="pipeline" --value="failing" --file="build/pipeline.svg" passing=green failing=red
    - name: Configure AWS credentials
      uses: aws-actions/configure-aws-credentials@v1
      with:
        aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
        aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
        aws-region: eu-west-1
    - name: Download lint artifact
      if: ${{ needs.lint.result == 'success' }}
      uses: actions/download-artifact@v3
      with:
        name: lint-report
        path: ./build/lint
    - name: Download coverage artifact
      if: ${{ needs.unittest.result == 'success' }}
      uses: actions/download-artifact@v3
      with:
        name: code-coverage-report
        path: ./build/coverage
    - name: Upload artifacts to S3
      run: aws s3 sync ./build s3://github-ci.experiments.neosperience.com/Neosperience/backpack/build/ --delete --acl public-read --cache-control no-cache