docs.yml

#
# Copyright 2020 IBM Corp. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

name: Docs

on:  # yamllint disable-line rule:truthy
  push:
    branches: 'master'
  pull_request:
    branches: '*'

jobs:
  test:

    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: [3.7]

    name: Docs
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}
      - name: Display Python version
        run: python -c "import sys; print(sys.version)"
      - name: Install Dependencies
        run: pip install -U -r requirements/tox.txt
      - name: Test
        run: tox -e docs -vv

      - uses: actions/upload-artifact@v2
        with:
          name: docs
          path: .tox/docs/out

      - name: Notify Gitter success
        run: |
          python -m pip install requests
          python .github/workflows/send_gitter.py
        if: ${{ success() && github.event_name == 'push' }}
        env:
          room-id: ${{ secrets.GITTER_ROOM_ID }}
          token: ${{ secrets.GITTER_TOKEN }}
          text: doc build succeeded

      - name: Notify Gitter failure
        run: |
          python -m pip install requests
          python .github/workflows/send_gitter.py
        if: ${{ failure() && github.event_name == 'push' }}
        env:
          room-id: ${{ secrets.GITTER_ROOM_ID }}
          token: ${{ secrets.GITTER_TOKEN }}
          text: doc build failed