Skip to content

release: 1.0.0 - #28

Merged
Paururo merged 1 commit into
mainfrom
release/1.0.0
Oct 18, 2026
Merged

Paururo merged 1 commit into
mainfrom
release/1.0.0

Conversation

@Paururo

@Paururo Paururo commented Oct 18, 2026

Copy link
Copy Markdown
Member

The 1.0.0 release, ready to merge and tag.

What changes

  • Version 1.0.0 in Cargo.toml and Cargo.lock, CITATION.cff (with date-released), SECURITY.md (supported versions) and the version placeholders of the issue and discussion templates.
  • CHANGELOG: the Unreleased section becomes ## [1.0.0] - 2026-10-18 with a short introduction, an empty Unreleased section sits above it, and the link lines compare v0.2.0...v1.0.0 and v0.1.0...v0.2.0. If the tag goes out another day, the date is a one-line change.
  • Example report regenerated with 1.0.0, from relative paths in a temporary folder, and marked as synthetic data again. Apart from the version and the timestamp it is byte for byte the previous one, and it still gives Rescued 11 / Matrix-corrected 8.
  • Release workflow: it now also runs on a pull request that changes it, and by hand, building the four binaries without publishing. Only a v* tag publishes, and only that job gets write access. This pull request is its first test run.
  • tools/check_site.py fails while Cargo.toml, CITATION.cff, the CHANGELOG and the example report disagree on the version. It was broken on purpose four ways and caught all four. The documentation workflow now also runs when LICENSE, CITATION.cff, the CHANGELOG or the contributing guide change, since the checks read them.
  • Contributing guide: a short Releasing section with the steps.

After merging

  1. Enable the repository in Zenodo, so the release gets a DOI.
  2. Create the v0.2.0 tag on 21ab509 (the commit the CHANGELOG dates 0.2.0), which reports made with 0.2.0 link to.
  3. Push the v1.0.0 tag: the workflow builds the binaries and publishes the release.
  4. Add the DOI to the README and CITATION.cff.

Locally fmt, clippy, the tests, the build, check_site.py --run-tutorial and the auto-merge gate check all pass.

The version moves to 1.0.0 in Cargo.toml, CITATION.cff, the CHANGELOG, SECURITY.md and the issue templates, and the example report is regenerated so the website shows it. The release workflow can now build its four binaries on a pull request or by hand without publishing, and check_site.py fails while those files disagree on the version.
@Paururo Paururo added documentation Improvements or additions to documentation ci Workflows, automation config, and the tools/ scripts packaging Cargo metadata, the lockfile, licensing, release labels Oct 18, 2026
@github-actions github-actions Bot added the report The HTML run report and what the writer emits label Oct 18, 2026
@github-advanced-security

Copy link
Copy Markdown

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

@Paururo
Paururo merged commit 7120fa0 into main Oct 18, 2026
16 checks passed
@Paururo
Paururo deleted the release/1.0.0 branch October 18, 2026 08:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Workflows, automation config, and the tools/ scripts documentation Improvements or additions to documentation packaging Cargo metadata, the lockfile, licensing, release report The HTML run report and what the writer emits

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants