Skip to content

Releases

Console UI uses semantic versioning: major.minor.patch. The version lives in Cargo.toml ([workspace.package]) and app/tauri.conf.json; scripts/release.py changes both together. Each version is an annotated vX.Y.Z tag.

Bumps When, since the last version, there is…
Major (minor while at 0.x) an incompatible change (! or BREAKING CHANGE)
Minor at least one feat
Patch anything else (fixes, polish…)
  1. Check that Unreleased in CHANGELOG.md and Sin publicar in CHANGELOG.es.md cover everything that changed, in both languages. The working tree must be clean.

  2. See which number comes next, from the commits since the last tag (with no tag yet, it suggests the current version):

    Terminal window
    python scripts/release.py --next
  3. Try it, then release:

    Terminal window
    python scripts/release.py 0.1.0 --dry-run
    python scripts/release.py 0.1.0

    --dry-run only prints the change and the notes. The real run:

    • sets the version in Cargo.toml and app/tauri.conf.json and updates Cargo.lock;
    • turns Unreleased and Sin publicar into ## [0.1.0] - <date> in both changelogs and adds the version’s link (a compare link from the previous version, or the tag for the first one);
    • commits chore(release): 0.1.0 and creates the annotated tag v0.1.0, whose message is the notes in English followed by the Spanish ones.

    It doesn’t push.

  4. Publish the commit and the tag:

    Terminal window
    git push --follow-tags
  5. Build the installer (see Build from source) and attach target/release/bundle/nsis/Console UI_0.1.0_x64-setup.exe to the version’s release on GitHub, with the tag’s notes.

The Changelog page is copied from CHANGELOG.md and CHANGELOG.es.md every time the site is built or served (scripts/sync-changelog.mjs, on predev and prebuild). It shows released versions only: the Unreleased / Sin publicar section and the line that explains it stay on GitHub.

Terminal window
cd docs
npm ci
npm run dev # http://localhost:4321
npm run build # into docs/dist, failing on any broken link

For GitHub Pages, build with BASE=/console-ui/docs: the landing page lives at the root of https://alenj0x1.github.io/console-ui/ and the docs under /docs.