docs.yaml

# Copyright (c) 2024 Intel Corporation
#
# 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:
  merge_group: null
  pull_request: null
  push:
    branches:
    - main
permissions: read-all
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
jobs:
  mkdocs:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      id-token: write
      pages: write
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: 3.8
          cache: pip
      - name: Install python requirements
        run: python -m pip install -r docs/requirements.txt
      - name: Build
        run: mkdocs build --clean
      - uses: actions/upload-pages-artifact@v3
        with:
          path: site
      - if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
        uses: actions/deploy-pages@v4