ci: GitHub Pages docs and firmware/provisioner CI - #9
Merged
Conversation
Add a Doxygen config that renders the firmware's documented C++ API to HTML, a make docs target to generate it locally, and a GitHub Actions workflow that builds the docs and deploys them to GitHub Pages (Pages is configured with the workflow build type).
Firmware CI checks clang-format and builds with PlatformIO; provisioner CI checks ruff formatting and runs mypy. Both trigger on pull requests and pushes to main (path-filtered) and can be run manually via workflow_dispatch. Based on the frost-mind reference.
JMTamayo
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds the GitHub Actions automation for the repo. The Pages commit was left out of #8 (it landed on the branch after that PR was merged); this PR brings it in along with the CI workflows.
Workflows
pages.yml(Docs) — builds the firmware Doxygen API docs (Doxygen + Graphviz) and deploys them to GitHub Pages on pushes tomain. Addsfirmware/Doxyfileand amake docstarget.firmware-ci.yml(Firmware CI) —format(clang-format--dry-run --Werror) thenbuild(PlatformIO).provisioner-ci.yml(Provisioner CI) —format(ruff) thentypecheck(mypy).CI workflows trigger on pull requests and pushes to
main(path-filtered to each subproject) and can also be run manually viaworkflow_dispatch.Result
Once merged, pushing to
mainpublishes the API docs to https://jmtamayo.github.io/bugbite/, and the CI workflows guard the firmware and provisioner.Testing
make -C firmware docsgenerates the HTML locally.clang-format --dry-run --Werrorpasses locally on the firmware sources.