Skip to content

📖 Publish Docs

📖 Publish Docs #18

Workflow file for this run

name: Publish Docs
on:
push:
paths:
- docs/**
- src/**
- mkdocs.yml
branches: [main]
# Allow manual trigger (workflow_dispatch)
workflow_dispatch:
jobs:
get_cache_key:
runs-on: ubuntu-latest
outputs:
cache_key: ${{ steps.set_cache_key.outputs.cache_key }}
steps:
- name: Set cache key
id: set_cache_key
run: echo "cache_key=docs-build-$(date --utc '+%V')" >> $GITHUB_OUTPUT
build_doxygen:
uses: hotosm/gh-workflows/.github/workflows/doxygen_build.yml@main
needs: [get_cache_key]
with:
cache_paths: |
docs/apidocs
cache_key: ${{ needs.get_cache_key.outputs.cache_key }}
build_openapi_json:
uses: hotosm/gh-workflows/.github/workflows/openapi_build.yml@main
needs: [get_cache_key]
with:
image: ghcr.io/hotosm/fmtm/backend:ci-${{ github.ref_name }}
example_env_file_path: ".env.example"
cache_paths: |
docs/openapi.json
cache_key: ${{ needs.get_cache_key.outputs.cache_key }}
publish_docs:
uses: hotosm/gh-workflows/.github/workflows/mkdocs_build.yml@main
needs:
- get_cache_key
- build_doxygen
- build_openapi_json
with:
image: ghcr.io/hotosm/fmtm/backend:ci-${{ github.ref_name }}
prepend_command: "gosu appuser"
cache_paths: |
docs/apidocs
docs/openapi.json
cache_key: ${{ needs.get_cache_key.outputs.cache_key }}