Skip to content

Release

oops-release-create

Create a release: update CHANGELOG, write migration script, commit, and tag.

Workflow: 1. Compute the next version (minor by default, or --major / --fix / --version). 2. Validate that CHANGELOG.md has a non-empty [Unreleased] (or pre-edited version) section. 3. Replace [Unreleased] with the versioned header and today's date (if not already replaced). 4. Write the migration script for addon changes since the last tag. 5. Commit all staged files and create an annotated git tag.

Use --dry-run to preview without writing anything.

Usage:

oops-release-create [OPTIONS]

Options:

Name Type Description Default
--major text Bump major version. False
--minor text Bump minor version (default). True
--fix text Bump fix/patch version. False
--version text Set version manually (e.g. v1.3.0). None
--no-commit boolean Stage changes but do not commit or tag. False
--no-tag boolean Commit but do not create a git tag. False
--dry-run boolean Show planned changes without writing anything. False
--help boolean Show this message and exit. False

Examples:

Create a minor release (default):

oops-release-create

Create a patch release:

oops-release-create --fix

Set the version explicitly:

oops-release-create --version v2.0.0

Preview what would happen without writing anything:

oops-release-create --dry-run

Commit without creating a tag:

oops-release-create --no-tag

oops-release-show

List all releases (semver tags) with their date and commit count.

Shows each vX.Y.Z tag sorted from newest to oldest, with the tag date, author, and the number of commits between that release and the previous one.

Usage:

oops-release-show [OPTIONS]

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Examples:

List all releases with their date, author and commit count:

oops-release-show