api_docs_gen.yml

# Copyright 2024 - 2025 Khalil Estell and the libhal contributors
#
# 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: 📚 Generate APIs Docs

on:
  workflow_call:
    inputs:
      dir:
        type: string
        default: .
      version:
        type: string
        default: ${{ github.ref_name }}
      repo:
        type: string
        default: ${{ github.repository }}
      repo_name:
        type: string
        default: ${{ github.event.repository.name }}
      dry_run:
        type: boolean
        default: false
      api_deploy_version:
        type: string
        default: 5.x.y

jobs:
  generate_api_docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          submodules: true
          repository: ${{ inputs.repo }}
          ref: ${{ inputs.version }}
      - uses: actions/setup-python@v4
        with:
          python-version: 3.x
      - run: sudo apt update
      - run: sudo apt install -y doxygen
      - run: pipx install conan>=2.20.0
      - run: pip install -r ${{ inputs.dir }}/docs/requirements.txt gitpython requests
      - run: conan config install https://github.com/libhal/conan-config2.git
      - run: conan hal docs --doc_version ${{ inputs.version }} ${{ inputs.dir }}/docs
      - name: print api docs version name
        run: echo ${{ inputs.api_deploy_version }}
      - run: wget https://raw.githubusercontent.com/libhal/ci/${{ inputs.api_deploy_version }}/.github/scripts/api_deploy.py
      - name: Deploy to API repo
        if: ${{ inputs.dry_run == false }}
        run: python api_deploy.py deploy --version ${{ inputs.version }} --repo-name ${{ inputs.repo_name }} --docs-dir ${{ inputs.dir }}/docs/build/
        env:
          GITHUB_TOKEN: ${{ secrets.API_PUSH_TOKEN }}