Skip to content

feat: automate semantic releases with release-please - #169

Merged
guilyx merged 11 commits into
mainfrom
feat/zen-gates-g3lolk
Nov 3, 2026
Merged

feat: automate semantic releases with release-please#169
guilyx merged 11 commits into
mainfrom
feat/zen-gates-g3lolk

Conversation

@guilyx

@guilyx guilyx commented Nov 3, 2026

Copy link
Copy Markdown
Member

What and why

Releases now follow semantic versioning, with the bump decided by what each merged PR contains. Nobody picks a number.

PR title (= the squashed commit) Release
fix: … / fix(lmcut): … / perf: … patch, 2.4.0 → 2.4.1
feat: … minor, 2.4.0 → 2.5.0
feat!: … or a BREAKING CHANGE: footer major, 2.4.0 → 3.0.0
docs: chore: ci: test: refactor: … none on its own

How it works

  1. pr-title.yml requires a Conventional Commit title. It is plain shell with no third-party action, and reads the title from an env var so the title can't inject into the script.
  2. release-please.yml runs on every push to main and keeps one release PR up to date (chore: release X.Y.Z). That PR:
    • bumps pyproject.toml, jupyddl.__version__ (via an x-release-please-version marker) and the manifest;
    • writes the changelog section from the merged titles;
    • runs tools/release_pr_fixup.py, which moves the hand-written ## [Unreleased] notes under the new version and rebuilds web/dist. The bundle records the version, and pages refuses to deploy a stale one.
  3. Merging the release PR = releasing. release-please tags the commit and creates the GitHub Release, then dispatches the existing release.yml on that tag: build → verify → PyPI (trusted publishing, unchanged) → attach artifacts.
    • Why a dispatch: a tag created with the workflow's own token starts no workflows, by GitHub's design. workflow_dispatch is the exception, so no personal token is needed.

Also

  • release.yml now refuses a manual dispatch that would re-release an existing version. Before, PyPI silently skipped the upload while the GitHub Release had its assets replaced from a different commit (flagged in the review).
  • Renovate opens semantic titles (chore(deps): …), so its PRs pass the check.
  • RELEASING.md, CONTRIBUTING.md, the PR template, AGENTS.md and CHANGELOG are updated.

⚠️ One-time settings a maintainer must change

  • Settings → Actions → General → Workflow permissions: tick Allow GitHub Actions to create and approve pull requests. Without it, release-please cannot open its PR.
  • Settings → General → Pull Requests: squash merging, with the default commit message set to Pull request title.
  • Don't make pr-title or tests required checks without an exception for the release PR. A PR opened with the workflow token starts no workflows, so those checks never report on it. release.yml repeats every check that matters before publishing.

How it was checked

  • New tests/test_release.py:
    • the manifest, pyproject.toml and __version__ agree;
    • the version marker is present;
    • every file release-please edits exists;
    • the changelog fix-up files the notes, is idempotent, and leaves today's changelog alone;
    • the section release.yml extracts for the release notes contains both the generated and the hand-written notes.
  • All three workflow files parse. Full suite: 518 passed, 1 skipped. flake8 and black are clean, and web/dist is rebuilt.
  • Not checked: release-please itself has not run yet. It first runs on the merge of this PR, which is feat:, so it should open a 2.5.0 release PR carrying all the Unreleased notes.

Checklist

  • flake8 jupyddl tests tools and pytest pass locally
  • web/dist rebuilt
  • CHANGELOG.md updated

The history has a merge -s ours of the already-merged #167 tip so the push fast-forwards. Squash-merge, keeping the PR title as the commit message.

Generated by Claude Code

claude added 11 commits November 2, 2026 21:26
@claude
State the intent to publish, and get ready for outside contributors
ff7dcde 
Write down where and why we mean to publish jupyddl as citable research
software (.docs/PUBLISHING.md): a Zenodo DOI per release, a JOSS paper,
ICAPS workshops for the research results, with a readiness checklist, the
paper outline, the AI-usage disclosure JOSS requires, and how contributors
can be considered for authorship. The README states the project's aim and
its Cite section now says which version the 2021 preprint describes.

Add the community files an outside contributor expects: a security policy,
a pull-request template, a "Propose an algorithm" issue template, and an
"Adding an algorithm" section in CONTRIBUTING.md.

Run tests and build on pull requests. They were `on: [push]`, which never
fires for a fork, so a contributor's PR showed no checks at all.

Fix AGENTS.md drift: the Python floor is 3.10 and Mergify is retired.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014RbGtRHF8XhkiPQCDVHtV2
@claude
Let other packages plug in, and write the guide to building on jupyddl
770b41a 
A package can now add planners, heuristics and generators by declaring
`jupyddl.planners`, `jupyddl.heuristics` or `jupyddl.generators` entry
points. Once installed, they work from the CLI, the benchmark harness and
`jupyddl.solve` by name, without anyone importing the package.

Discovery is lazy and defensive (jupyddl/plugins.py): the CLI runs it
before building its parser, the library only on a registry miss, so
importing jupyddl never scans installed packages. A built-in name always
wins, a plugin that fails to import is skipped with a warning, and
JUPYDDL_NO_PLUGINS=1 turns it off. `jupyddl plugins` lists what was found.
The CLI now reads `requires_heuristic` from the registry at call time,
since INFORMED_PLANNERS is fixed at import and cannot know about plugins.

.docs/EXTENDING.md walks through a heuristic, a planner from a priority
function, a planner from scratch with the budget/observer contract, a
generator, testing the guarantees you claim, and shipping as a plugin.
tests/test_extending.py runs every Python block in it, so it cannot drift.

best_first now accepts a tuple priority for tie-breaking; observers get
its first element as `f`, so traces stay numeric.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014RbGtRHF8XhkiPQCDVHtV2
@claude
Merge the already-merged #163 branch tip so this push fast-forwards
e1d4f83 
# Conflicts:
#	.docs/PUBLISHING.md
#	AGENTS.md
#	CHANGELOG.md
@claude
Fix wrong answers in the task model and heuristics
a5ef363 
Each of these returned a plan, a cost or a value without complaint, and
validate_plan accepted the plans because it replays them through the same
Task.apply. tests/test_semantics.py now pins them on tiny hand-written
tasks; 16 of its cases fail on the previous code.

- Derived facts were never retracted, and (not <derived>) held from the
  start. close() now recomputes axioms from scratch and maintains negated
  derived facts; negation inside a rule body (needs stratification) is
  refused. The relaxation gets the complement for free, so it never calls
  a solvable state a dead end.
- An atom both added and deleted left its complement true too; a `when`
  re-adding a deleted atom did the same. Complements: the delete wins.
- Under a (total-cost) metric an action without a cost effect is free, as
  in IPC planners (pegsol/sokoban optimised the wrong objective). Cost
  inside `when` was charged unconditionally: refused, as are negative costs.
- A never-defined numeric fluent read as 0; conditions reading one fail.
- blind skipped zero-cost actions and overestimated.
- h1/h2/hm crashed on numeric states; LM-cut crashed on an empty goal.
- lmcut and h2 clear `admissible` on tasks with conditional effects.
- Optimal planners default to lmcut, not hff; `-H none` means blind.
- make_heuristic builds a heuristic class or partial instead of passing it
  through unbuilt.
- Fact ids and id sets are built in sorted order, so LM-cut tie-breaks,
  expansions and plans no longer change with PYTHONHASHSEED.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014RbGtRHF8XhkiPQCDVHtV2
@claude
Record the already-merged #164 branch tip so this push fast-forwards
76c970b
@claude
Make every planner honour its budget and claim only what it guarantees
0333b0d 
- iddfs, idastar and ehc never read their budget, so --time-limit was
  ignored. They poll per expansion now; the recursive ones unwind with
  BudgetExhausted. beam polls per node, not per layer, and bnb stops
  evaluating siblings once the budget fires.
- Hitting a depth cap (iddfs max_depth, bnb max_depth) or Python's
  recursion limit sets stats.truncated: it is not a proof of
  unsolvability, nor of optimality.
- bfs and iddfs leave OPTIMAL_PLANNERS: they minimise plan length, and on
  errands return cost 16 where 10 is optimal.
- Live dashboard: a budget stop no longer reads "no plan found"; lines are
  clipped to the stream's terminal width so repaints do not smear; the
  non-tty log writes at most every two seconds.
- idastar/ehc/hc/beam without a heuristic raise a clear ValueError;
  MultiObserver forwards positional arguments; the SearchObserver and
  best_first docstrings say what actually happens.

tests/test_search_contract.py runs every planner where the budget is the
only thing that stops it, checks OPTIMAL_PLANNERS against dijkstra under
action costs, and pins the dashboard behaviour.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014RbGtRHF8XhkiPQCDVHtV2
@claude
Record the already-merged #165 branch tip so this push fast-forwards
5353db4
@claude
Make the command line safe to script, and the charts survive a dead end
f7d7334 
- Exit codes say what happened: 0 solved, 1 no plan, 2 bad input, 3
  stopped by a budget, 4 a plan that failed validation. Unsolvable, out of
  budget and a crash all used to exit 1.
- Bad input (missing file, parse error, unknown planner or heuristic, a
  malformed --sizes) is one line on stderr, not a traceback;
  JUPYDDL_DEBUG=1 restores the traceback. --version exists.
- `demo` and `benchmark demos` never finished. Both stop each search after
  10 s by default (--time-limit 0 for none); animate and demo take the
  same budget flags as solve.
- benchmark validates --planners/--heuristic/--metric up front, and chart
  options check for the viz extra before searching rather than after.
- Dead ends (h = inf) crashed the progress chart and coloured the
  wavefront NaN; in the workbench they made the progress message invalid
  JSON and aborted the run.
- A trace's plan is the visible plan, without compiler bookkeeping.
- Packaging: the sdist's own suite failed because .github/ was dropped
  wholesale; only workflows are excluded now. build runs twine --strict.
  black is pinned to one major in dev and format.yml; Renovate pins
  third-party actions to digests.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014RbGtRHF8XhkiPQCDVHtV2
@claude
Record the already-merged #166 branch tip so this push fast-forwards
0f83777
@claude
feat: automate semantic releases with release-please
b4981a4 
PR titles become Conventional Commits (pr-title check, plain shell, no
third-party action). On every push to main release-please keeps one release
PR whose version follows from what was merged: fix -> patch, feat -> minor,
feat!/BREAKING CHANGE -> major. tools/release_pr_fixup.py then files the
hand-written [Unreleased] notes under the new section and rebuilds web/dist,
which records the version.

Merging the release PR tags the commit; release-please.yml then dispatches
release.yml on the tag, because a tag made with the workflow token triggers
no workflows. release.yml now also refuses a dispatch that would re-release
an existing version. Renovate opens semantic titles so its PRs pass the check.

tests/test_release.py pins the manifest, pyproject and __version__ together
and checks the changelog fix-up, including the section release.yml extracts.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014RbGtRHF8XhkiPQCDVHtV2
@claude
chore: record the already-merged #167 branch tip so this push fast-fo…
7af289e 
…rwards
@guilyx
guilyx marked this pull request as ready for review November 3, 2026 08:34
@guilyx
guilyx merged commit 9d05b56 into main Nov 3, 2026
11 checks passed
guilyx pushed a commit that referenced this pull request Nov 3, 2026
@claude
chore: record the already-merged #169 branch tip so this push fast-fo…
871f09b 
…rwards
This was referenced Nov 3, 2026
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@guilyx @claude