Skip to content

Releases

v0.14.0

Choose a tag to compare

@github-actions github-actions released this 14 Nov 22:23
ffccb66

🛠 Enhancements

  • SITE18, in rules/site.md: the documentation is built with
    julia --project=docs docs/make.jl, the command of CI, and the header of
    docs/make.jl gives it. With --project=. the root is the active project and shadows
    docs/ despite the push!. Origin: most headers said --project=. (#63).
  • MOD3, in rules/modules.md: a user-facing package (MOD8) may
    use import in one folder, its import layer, named in its AGENTS.md:
    @reexport import Pkg.Sub: sym for the names it exports, import Pkg.Sub: sym for the
    names it binds without exporting them. The folder only binds names, and the guard
    exempts it alone. Origin: OptimalControl.jl's src/imports/, which binds names such as
    OptimalControl.Ipopt that no allowed using form reaches (#62).
  • PERF5, in rules/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 shared const input when the wrapper must copy. Origin: two guards of
    CTModels' test/suite/meta/test_performance.jl that measured a comparison artifact
    (#53).

📚 Documentation

  • method.md, "Build command": the docs are built with
    julia --project=docs docs/make.jl, and make.jl appends the package root to
    LOAD_PATH — the page said --project=. and "prepends", against SITE18.

✅ Compatibility

  • No breaking changes: rule identifiers unchanged; SITE18 asks a package to fix
    one comment line in docs/make.jl, MOD3 only relaxes, and PERF5 only adds
    guidance. See BREAKING.md.

v0.13.0

Choose a tag to compare

@github-actions github-actions released this 13 Nov 12:30
8e749e9

✨ New Features

  • CHG6, in rules/changelog.md: [Unreleased] stays in the format
    of CHG2, with its counterpart under ## Unreleased or ## Non-breaking note (Unreleased) in BREAKING.md; whoever edits these files, a person or an agent, in any
    pull request, runs release.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, in rules/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

Choose a tag to compare

@github-actions github-actions released this 11 Nov 16:30
8e59b3d

🛠 Enhancements

  • MOD8, in rules/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 its AGENTS.md. This records the
    practice of the user-facing packages, which the rule did not allow.

v0.11.0

Choose a tag to compare

@github-actions github-actions released this 07 Nov 14:28
d164eca

✨ New Features

  • SITE13 tightened: make.jl takes the deploy decision once, with the preview label
    (Documenter.deploy_folder(…; push_preview)), passes it to MarkdownVitepress as
    deploy_decision, and calls deploydocs only when deploy_decision.all_ok. Without it,
    DocumenterVitepress decides with push_preview=true hard-coded, so every pull request
    without the documentation push preview label was built for previews/PR<n> and
    announced a deployment that deploydocs then refused. Origin:
    OptimalControlProblems.jl#410,
    fixed in
    OptimalControlProblems.jl#411.

v0.10.0

Choose a tag to compare

@github-actions github-actions released this 02 Nov 21:39
75e760e

✨ New Features

  • PERF7, in rules/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

Choose a tag to compare

@github-actions github-actions released this 23 Oct 20:47
5006689

✨ New Features

  • SGN1–SGN6, a new rule file rules/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 f and max -f have 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-Hamiltonian p·f + p⁰ℓ + μ·g is always maximised, with
    p⁰ = −1 for a minimisation and +1 for 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

Choose a tag to compare

@github-actions github-actions released this 21 Oct 08:00
bfac6f8

✨ New Features

  • SITE18, docs/make.jl appends the repository root to LOAD_PATH (push!, never
    pushfirst!), so that docs/Manifest.toml wins for shared dependencies. A root that
    comes first broke GPUCompiler (CTSolvers) and the precompilation of an extension on a
    weak dependency (CTFlows). Packages with a pushfirst!(LOAD_PATH, ...) in
    docs/make.jl switch to push!.

v0.7.1

Choose a tag to compare

@github-actions github-actions released this 19 Oct 21:53
d990eaf

📚 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.1 renames the directory (mv .conventions .ct-conventions, or clone again) and
    the entries in its AGENTS.md, .gitignore and _typos.toml; the grep of GEN2 also
    skips .ct-agents.

v0.7.0

Choose a tag to compare

@github-actions github-actions released this 19 Oct 09:32
1ae2553

✨ New Features

  • REL1–REL7, a new rule file rules/release.md: version
    numbers follow SemVer as Pkg reads it (the leftmost non-zero component is the breaking
    one, so 0.Y.Z bumps Y for a breaking change); a beta takes the -beta suffix 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

Choose a tag to compare

@github-actions github-actions released this 18 Oct 15:58
86e082a

✨ New Features

  • TST8: every package extension is checked for type piracy and method ambiguities
    (Aqua.test_all skips 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 the CTBaseAqua extension.