Skip to content

docs(doxygen): migrate to shared workflow and standardize Doxyfile#579

Merged
kcenon merged 1 commit into
mainfrom
docs/doxygen-shared-workflow-and-standardization
Mar 17, 2026
Merged

docs(doxygen): migrate to shared workflow and standardize Doxyfile#579
kcenon merged 1 commit into
mainfrom
docs/doxygen-shared-workflow-and-standardization

Conversation

@kcenon

@kcenon kcenon commented Mar 17, 2026

Copy link
Copy Markdown
Owner

What

Summary

Replace inline Doxygen workflow (50 lines) with the shared reusable workflow from common_system (15 lines). Add PROJECT_NUMBER to Doxyfile.

Change Type

  • Documentation
  • Chore

Why

Related Issues

Motivation

The inline workflow duplicates logic already centralized in common_system's shared workflow. This divergence causes version drift (e.g., actions/checkout@v6 vs @v5 in the shared workflow) and increases maintenance burden.

Where

Files Changed

File Change
.github/workflows/build-Doxygen.yaml 50 lines → 15 lines (shared workflow)
Doxyfile Add PROJECT_NUMBER = 0.1.0

How

Implementation Details

  1. Workflow migration: Replaced inline steps with uses: kcenon/common_system/.github/workflows/doxygen.yml@main
  2. Common system checkout: checkout-common-system: true preserves the existing dependency checkout
  3. Submodules: checkout-submodules: 'true' preserves the existing submodule checkout
  4. PROJECT_NUMBER: Added 0.1.0 to match vcpkg.json version

Testing Done

  • Workflow YAML syntax validated
  • Shared workflow input parameters verified against common_system definition
  • Doxyfile settings verified

Test Plan

  1. PR triggers Doxygen build (no deploy) — verify build succeeds
  2. After merge, push to main triggers build + deploy
  3. Verify GitHub Pages still accessible

Replace 50-line inline Doxygen workflow with the shared reusable
workflow from common_system. This centralizes Doxygen version,
Graphviz setup, and deployment configuration.

Standardize Doxyfile settings:
- PROJECT_NUMBER: add 0.1.0 (sync with vcpkg.json)

Closes #578
@kcenon kcenon merged commit e00e037 into main Mar 17, 2026
25 checks passed
@kcenon kcenon deleted the docs/doxygen-shared-workflow-and-standardization branch March 17, 2026 23:33
kcenon added a commit that referenced this pull request Apr 13, 2026
)

Replace 50-line inline Doxygen workflow with the shared reusable
workflow from common_system. This centralizes Doxygen version,
Graphviz setup, and deployment configuration.

Standardize Doxyfile settings:
- PROJECT_NUMBER: add 0.1.0 (sync with vcpkg.json)

Closes #578
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(doxygen): Migrate to shared Doxygen workflow from common_system

1 participant