Skip to content

[Chore] Release and CI infrastructure: CHANGELOG, BREAKING, release workflows, label-gated CI #312

Closed

Description

@ocots

Agents: read the guide for agents in #310 first (order, difficulty, how to claim an issue, working method). The specification is in this description and in the comments below.

Goal

Give this package the release and CI infrastructure of the other packages of the organization, so that releases (0.6.0-beta in ct-registry, see #283, then stable versions) follow recipes/release.md of ct-agents and rules REL1–REL7 of ct-conventions.

Part of #310, step 0. Depends on #313: theme 1 (AGENTS.md, pinned conventions) and theme 2 (the labels used below must exist).

Why the CI workflows change too

In the other packages, PR jobs run only when a label is set (run ci github-runner, run documentation, run breakage); on main and on tags they always run. Here, CI.yml and Documentation.yml run on every PR without labels. The release gate (ReleaseGate.yml) requires every label-gated job to have run, so the gate only works once CI and documentation are label-gated. See CTActions docs/conventions/labels.md and docs/workflows/release-gate.md.

Work

Model for every workflow: the file of the same name in CTFlows.jl (.github/workflows/), adapted to this package. One commit per item.

  1. CHANGELOG.md and BREAKING.md (rules CHG1–CHG5). Baseline entry for the last stable release, as CHG5 prescribes: ## [0.5.0] - 2026-03-10 — baseline, no reconstructed history; BREAKING.md starts at the same point.
  2. New workflows, callers of the CTActions reusable workflows:
    • ReleaseGate.yml (release-gate.yml);
    • ReleaseTag.yml (release-tag.yml, on push to main touching Project.toml, and workflow_dispatch);
    • Breakage.yml (breakage-suite.yml, label run breakage; the only dependent package in the organization today is CTBenchmarks.jl);
    • DocPreviewCleanup.yml (documentation-preview-cleanup.yml).
  3. CI.yml: on PRs, only with the label run ci github-runner; always on main and tags. Runners ubuntu-latest, macos-latest, windows-latest; Julia 1.10 and 1.12. Use the guard against repeated labeled events as in CTFlows.
  4. Documentation.yml: on PRs, only with run documentation (documentation push preview deploys the preview); deploy on stable tags only (SITE13); workflow_dispatch (run by ReleaseTag on the tag).
  5. Coverage.yml: aligned on CTFlows.
  6. use_ct_registry: true in every workflow that has the input. Harmless while all dependencies come from General; required by the port to v2 ([Paper] Port to OptimalControl v2 and new problem interface #283).

Out of scope

Done when

  • CHANGELOG.md and BREAKING.md exist with the 0.5.0 baseline.
  • The six workflows above exist or are updated; use_ct_registry: true everywhere.
  • On a test PR: nothing runs without labels; run ci github-runner runs the CI on the three OSes; run documentation (+ documentation push preview) builds and previews the docs; run breakage tests CTBenchmarks.jl.
  • The release gate passes on that test PR in local mode: julia scripts/release/release.jl gate --base <base sha> --labels "run breakage,run ci github-runner,run documentation" <clone> (see CTActions docs/workflows/release-gate.md); nothing is released.
  • Windows: the existing tests pass, or the failures are reported here.

Activity

  1. added
    devInternal change, no user-facing impact
    on Nov 4, 2026
  2. changed the title [-][Chore] Release infrastructure: CHANGELOG, BREAKING and release workflows[/-] [+][Chore] Release and CI infrastructure: CHANGELOG, BREAKING, release workflows, label-gated CI[/+] on Nov 4, 2026
  3. ocots commented on Nov 4, 2026

    @ocots
    MemberAuthor

    Taken by an agent; draft PR to follow.

  4. ocots commented on Nov 4, 2026

    @ocots
    MemberAuthor

    Implementation is ready in draft PR #318, now based on main after #313, #316, and #317 were merged. The branch contains the 0.5.0 CHANGELOG/BREAKING baseline, release workflows, label-gated CI and documentation, CT registry-enabled callers, and coverage alignment. Local actionlint, git diff --check, and the CTActions release-gate check pass. GitHub-hosted CI and the test-PR label checks remain for review.

  5. ocots commented on Nov 4, 2026

    @ocots
    MemberAuthor

    Completed in PR #318, merged into main.

    • Added the 0.5.0 baseline CHANGELOG.md and BREAKING.md.
    • Added the release gate, release tag, breakage, and documentation preview cleanup workflows.
    • Made CI and documentation label-gated on pull requests, with runs on main and stable tags.
    • Aligned coverage and enabled use_ct_registry: true in the applicable workflows.
    • Verified the workflows with actionlint and the local CTActions release gate.

    No package source or test code was changed. Closing this issue.

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

Metadata

Metadata

Assignees

Labels

devInternal change, no user-facing impact

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions