Standardize CI/docs to Harmoniqs known-good layout#3
Merged
Conversation
Adds docs/ (Documenter + PiccoloDocsTemplate), docs/CompatHelper/nightly/ Formatter workflows, and upgrades CI.yml to the DirectTrajOpt reference (Julia 1.10/1.11/1.12 + coverage). No source changes.
Makes the source clean under the Formatter workflow added in this PR. Pure formatting (JuliaFormatter 2.10.0 defaults); test suite unchanged at 133/133.
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.
Standardize CI/docs to the Harmoniqs known-good layout
Brings Intonato's repo infrastructure up to the reference layout used by
DirectTrajOpt/Piccolo. No source changes — infra only.
CI
CI.ymlupgraded to the DirectTrajOpt reference: Julia 1.10 / 1.11 / 1.12(was 1.10 / 1.11 only) + coverage (
processcoverage+codecov),workflow_dispatch,cache-delete permissions, 60-min timeout.
Added
.github/workflows/CompatHelper.yml,nightly.yml,Formatter.yml.github/workflows/docs.yml(Documenter deploy + PiccoloMultiDocs dispatch)docs/scaffold:make.jl,Project.toml,get_docs_utils.sh,src/lib.md(PiccoloDocsTemplate,
@autodocs Modules = [Intonato]).gitignoreto the reference (docs build artifacts, coverage, etc.; keeps.claude/)Formatting (separate commit)
The new
Formatter.ymlflagged the existing source (not clean under JuliaFormatter2.10.0). The 2nd commit
style: apply JuliaFormatterreformats 20 files — purewhitespace/wrapping, no logic changes (test suite unchanged). Reviewable in isolation;
skip it and read commit 1 for the actual infra change.
Note
Docs build in CI immediately; docs deploy needs the org secrets
(
REPO_ACCESS_TOKEN,DOCUMENTER_KEY) and Intonato added to PiccoloMultiDocs —an org-config step, not part of this PR.
Validation (local, Julia 1.12.6)
Pkg.instantiate()✓ ·using Intonato✓test/runtests.jl→ 133 / 133 pass