Release¶
Prepare and inspect versioned releases.
Modules:
| Name | Description |
|---|---|
create |
Create a release: update CHANGELOG, write migration script, commit, and tag. |
show |
List all releases (semver tags) with their date and commit count. |
oops release create¶
Create a release: update CHANGELOG, write migration script, commit, and tag.
Workflow:
- Compute the next version (minor by default, or --major / --fix / --version).
- Validate that CHANGELOG.md has a non-empty [Unreleased] (or pre-edited version) section.
- Replace [Unreleased] with the versioned header and today's date (if not already replaced).
- Write the migration script for addon changes since the last tag.
- Commit all staged files and create an annotated git tag.
Use --dry-run to preview without writing anything.
Usage:
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):
Create a patch release:
Set the version explicitly:
Preview what would happen without writing anything:
Commit without creating a 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:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Examples:
List all releases with their date, author and commit count: