api.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: 📚 Deploy APIs

on:
  release:
    types:
      - published
  push:
    branches:
      - main
  workflow_dispatch:

permissions:
  contents: write

jobs:
  v4_api:
    uses: libhal/ci/.github/workflows/api_docs_gen.yml@5.x.y
    with:
      dir: v4
    secrets: inherit

  # TODO(#191): Comment out the code below and add a condition for v5 and v4
  # docs depending on the ref_name. If the ref_name is "main", the v4 also run
  # until we decide to release v5

  # v5_api:
  #   uses: libhal/ci/.github/workflows/api_docs_gen.yml@5.x.y
  #   with:
  #     dir: v5
  #   secrets: inherit