Doxygen Build¶

This workflow is used to build a Doxygen class hierarchy.

It needs a Doxyfile present under docs/Doxyfile.

Inputs¶

INPUT	TYPE	REQUIRED	DEFAULT	DESCRIPTION
output_path	string	false		If specified, the output dir is uploaded named `artifact`.

Outputs¶

OUTPUT	VALUE	DESCRIPTION
artifact_name	`"doxygen"`	The artifact name (default: `artifact`).

Secrets¶

No secrets.

Example Usage¶

name: 📖 Publish Docs

on:
  push:
    paths:
      - docs/**
      - src/**
      - mkdocs.yml
    branches: [development]
  # Allow manual trigger (workflow_dispatch)
  workflow_dispatch:

jobs:
  build_doxygen:
    uses: hotosm/gh-workflows/.github/workflows/doxygen_build.yml@1.6.0
    with:
      output_path: docs/apidocs

  publish_docs:
    uses: hotosm/gh-workflows/.github/workflows/mkdocs_build.yml@1.6.0
    needs:
      - build_doxygen
    with:
      image: ghcr.io/${{ github.repository }}/backend:ci-${{ github.ref_name }}
      doxygen: true