Repository navigation
Add release script #36
Description
Activity
Queued as
WinchControllers.jl-36.Question from
WinchControllers.jl-36There already is one:
bin/releasehas been on main since 092b528 (Uwe, 2026-08-14). It checks that you are on a clean, synced main and that Project.toml's version matches the top### WinchControllers vX.Y.Zentry in CHANGELOG.md, syncs CITATION.cff, then posts@JuliaRegistrator register()with those notes on #4, and TagBot tags. It does not bump the version or date the changelog. What should #36 add? A) Nothing, close it as done. B) Havebin/release <version>also do the bump: setversionin Project.toml, turn(unreleased)into today's date and sync CITATION.cff in one commit, then register as it does now. C) Something else, please say what. My recommendation is A. The bump isagent release's job, and doing it in a second place would duplicate it. (The brokenbin/install -ythat blocked this worktree is queued separately as #37.)Registration pull request created: JuliaRegistries/General/169564
Recommendation: add release notes
Release notes help your users know what has changed in the new version. For breaking releases in particular, it's recommended to document what breaking changes were made (or point to where changes can be found, such as a changelog).
To add release notes, just add markdown formatted text underneath the comment after the text "Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the release that TagBot creates. i.e.
@JuliaRegistrator register Release notes: ## Breaking changes - blahTo add release notes to this registration, just re-invoke JuliaRegistrator and the PR will be updated.
Tagging
After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.
This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:
git tag -a v0.7.0 -m "<description of version>" af62939a4168f51a319eec4ec9b3e19baa392645 git push origin v0.7.0
