Releasing

SkillDev tools

Releasing a new JustRelax.jl version — version bumps, compat bumps, JuliaRegistrator, TagBot. Use when preparing or asked about a release.

Available today. Use it from your connected AI after setup.

No other account needed.

Connect ahel once, and every AI you use reads what you have installed.

Then ask your AI: use the Releasing skill

What this skill tells your AI

The instructions your AI receives, as published by ptsolvers/justrelax.jl in .claude/skills/release/SKILL.md and read by ahel’s review.

JustRelax.jl is registered in the Julia General registry. Releases are driven from main.

Bump version in Project.toml (currently 0.x — patch for fixes, minor for features/breaking, per common 0.x SemVer practice in the Julia ecosystem).
Make sure [compat] entries are current. The tightly-coupled companion packages are GeoParams and JustPIC (both PTsolvers); a JustRelax release often follows a compat bump for one of these. Dependabot handles GitHub Actions, not Julia compat — compat bumps are manual or via CompatHelper-style PRs.
Ensure CI is green on main, including the CSCS GPU pipeline if solver code changed.
On the GitHub commit of the version bump (after merge to main), comment:
```
@JuliaRegistrator register
```
JuliaRegistrator opens the General registry PR; once merged, TagBot (.github/workflows/TagBot.yml) creates the GitHub tag/release automatically. Do not create tags by hand.

CITATION.cff has its own validation workflows (cff-validator.yml, validate_zenodo.yml); update it if authors change. A release also triggers Zenodo archiving via the repo's Zenodo integration.
Breaking changes to exported API should be noted in the release notes (Registrator picks up the text under the @JuliaRegistrator register comment via Release notes: block).

Advanced