blocklet version

The blocklet version command updates the version of your blocklet in the blocklet.yml file. It follows standard Semantic Versioning (SemVer) rules to increment the version number. This command also automatically updates the specVersion to the latest version supported by the CLI.

This is a crucial step before packaging your blocklet for release, ensuring that each new version is correctly tagged.

Usage#

Workflow#

The command executes a series of steps to safely update your blocklet's version.

Arguments#

Argument	Description
newversion	Optional. Specifies the new version. It can be a valid SemVer string (e.g., 1.2.3) or a keyword for incrementing (major, minor, patch, prerelease, etc.). Defaults to patch.

Options#

Option	Description
--git-commit	Automatically adds blocklet.yml to Git and creates a commit with the message "blocklet version [new_version]".
--force	Forces the update even if it results in downgrading the specVersion. This might be necessary if you are using an older version of Blocklet CLI that has a lower specVersion.

Examples#

Increment the Patch Version#

If your current version is 1.0.0, running the command without arguments will increment the patch number.

Output:

Increment the Minor Version and Commit#

To bump the minor version and create a Git commit automatically, use the --git-commit flag.

Output:

Set a Specific Version#

You can set a precise version number, including pre-release identifiers.

Output:

Handling specVersion Downgrade#

If the CLI's specVersion is lower than the one in your blocklet.yml, the command will prevent a downgrade by default to ensure compatibility. You will see an error message prompting you to upgrade your CLI.

Error Output:

To override this safety check, you can use the --force flag.

After versioning your blocklet, the next step is often to package it for distribution. Learn more in the blocklet bundle command reference. For more details on the blocklet.yml manifest file, see the Project Structure guide.