Repository navigation
Releases
Releases · control-toolbox/ct-conventions
v0.14.0
🛠 Enhancements
SITE18, inrules/site.md: the documentation is built with
julia --project=docs docs/make.jl, the command of CI, and the header of
docs/make.jlgives it. With--project=.the root is the active project and shadows
docs/despite thepush!. Origin: most headers said--project=.(#63).MOD3, inrules/modules.md: a user-facing package (MOD8) may
useimportin one folder, its import layer, named in itsAGENTS.md:
@reexport import Pkg.Sub: symfor the names it exports,import Pkg.Sub: symfor the
names it binds without exporting them. The folder only binds names, and the guard
exempts it alone. Origin: OptimalControl.jl'ssrc/imports/, which binds names such as
OptimalControl.Ipoptthat no allowedusingform reaches (#62).PERF5, inrules/performance.md: how to write the raw side
of a wrapper-vs-raw allocation guard, so that the compiler cannot elide on it what the
wrapper performs: inputs interpolated on both sides, one specialised function for the
whole sequence, a sharedconstinput when the wrapper must copy. Origin: two guards of
CTModels'test/suite/meta/test_performance.jlthat measured a comparison artifact
(#53).
📚 Documentation
method.md, "Build command": the docs are built with
julia --project=docs docs/make.jl, andmake.jlappends the package root to
LOAD_PATH— the page said--project=.and "prepends", againstSITE18.
✅ Compatibility
- No breaking changes: rule identifiers unchanged;
SITE18asks a package to fix
one comment line indocs/make.jl,MOD3only relaxes, andPERF5only adds
guidance. See BREAKING.md.
v0.13.0
✨ New Features
CHG6, inrules/changelog.md:[Unreleased]stays in the format
ofCHG2, with its counterpart under## Unreleasedor## Non-breaking note (Unreleased)inBREAKING.md; whoever edits these files, a person or an agent, in any
pull request, runsrelease.jl lint-changelog(CTActions) and leaves it green. An agent
fixes the format itself and reports the judgments it made. Origin: the release of
CTParser 0.9.6, where a section out of order was found, and a format error would have
given a wrong version without any signal.CHG2's check is now partly tooled.
🛠 Enhancements
REL6, inrules/release.md: the bot takes the comment of a public
member of the organization, not of a GitHub App. A mention it refuses (an answer without
a pull request of General) registered nothing and does not count; the text handed to a
person writes the name with an apostrophe, which they remove before posting. Origin: the
release of CTParser 0.9.6, where the App's comment was refused and a person posted it
(CTActions#155).
v0.12.0
🛠 Enhancements
MOD8, inrules/modules.md: the top-level rule now depends on
who loads the package. An internal package (CTBase,CTModels…) still exports
nothing at top level; a user-facing package (OptimalControl,
OptimalControlProblems…) exports its user API, each name exported by a submodule or
re-exported from a dependency, and says so in itsAGENTS.md. This records the
practice of the user-facing packages, which the rule did not allow.
v0.11.0
✨ New Features
SITE13tightened:make.jltakes the deploy decision once, with the preview label
(Documenter.deploy_folder(…; push_preview)), passes it toMarkdownVitepressas
deploy_decision, and callsdeploydocsonly whendeploy_decision.all_ok. Without it,
DocumenterVitepress decides withpush_preview=truehard-coded, so every pull request
without thedocumentation push previewlabel was built forpreviews/PR<n>and
announced a deployment thatdeploydocsthen refused. Origin:
OptimalControlProblems.jl#410,
fixed in
OptimalControlProblems.jl#411.
v0.10.0
✨ New Features
PERF7, inrules/performance.md: a collection of
callables on the hot path is stored in a concretely-typed tuple and applied by
static unrolling (@generated), with the measured table of what each shortcut
actually costs (abstractly-typed vector, plain loop over a heterogeneous
tuple, tuple recursion past the inference limit). Origin:
CTModels.jl#496,
implemented in
CTModels.jl#497.
v0.9.0
✨ New Features
SGN1–SGN6, a new rule filerules/signs.md: one sign convention
for the multipliers of the NLP solvers, the costate and multipliers of the maximum
principle, and the duals of an optimal control solution
(OptimalControl.jl#1014).
min fandmax -fhave the same multipliers; an inequality has a nonnegative
multiplier however it is written; equalities and two-sided constraints carry the signed
y = μU − μL; the pseudo-Hamiltonianp·f + p⁰ℓ + μ·gis always maximised, with
p⁰ = −1for a minimisation and+1for a maximisation; the same constraint has the
same dual for every kind and every method; a package wrapping NLP solvers tests the
native convention of each solver and its normalised output separately.
v0.8.0
✨ New Features
SITE18,docs/make.jlappends the repository root toLOAD_PATH(push!, never
pushfirst!), so thatdocs/Manifest.tomlwins for shared dependencies. A root that
comes first broke GPUCompiler (CTSolvers) and the precompilation of an extension on a
weak dependency (CTFlows). Packages with apushfirst!(LOAD_PATH, ...)in
docs/make.jlswitch topush!.
v0.7.1
📚 Documentation
- The local clone of the conventions in a package is named
.ct-conventions/instead of
.conventions/, to match.ct-agents/, the clone of
ct-agents a package pins the same way.
Rewording only: no rule changes, and no identifier either. A package that bumps to
v0.7.1renames the directory (mv .conventions .ct-conventions, or clone again) and
the entries in itsAGENTS.md,.gitignoreand_typos.toml; thegrepofGEN2also
skips.ct-agents.
v0.7.0
✨ New Features
REL1–REL7, a new rule filerules/release.md: version
numbers follow SemVer as Pkg reads it (the leftmost non-zero component is the breaking
one, so0.Y.ZbumpsYfor a breaking change); a beta takes the-betasuffix and
a triple never used before, and a stable never takes the triple of a beta; a version
jump in General is allowed only when betas explain it, and approved with
[merge approved]; a stable release resolves from General alone; version, tag,
registry and GitHub release agree, the notes of a stable covering the changes since
the previous stable; the registration bot is mentioned exactly once, in one comment
of the release issue; a release ships a change to what users get (code,Project.toml
or documentation), not tests or CI alone (REL7).
v0.6.0
✨ New Features
TST8: every package extension is checked for type piracy and method ambiguities
(Aqua.test_allskips extensions), with the parent package treated as owned and
by-design piracy listed explicitly. The shared helper is
CTBase.DevTools.test_extensions_quality, provided by theCTBaseAquaextension.