メインコンテンツへスキップ

Manage Blocklet Versions

This documentation provides guidelines on managing the versioning of Blocklets, ensuring consistency and clarity across releases.

Semantic Versioning

Blocklet versions follow Semantic Versioning (SemVer) principles. SemVer consists of three numbers separated by dots: MAJOR.MINOR.PATCH.

  • MAJOR: Increments when there are incompatible changes or major feature enhancements.
  • MINOR: Increments when new functionality is added in a backward-compatible manner.
  • PATCH: Increments with backward-compatible bug fixes.

Incrementing Blocklet Version

The version of a Blocklet should be incremented according to the type of change introduced.

Manual Versioning

To manually update the version:

javascript
bashCopy codeblocklet version major    # Increment MAJOR version
blocklet version minor    # Increment MINOR version
blocklet version patch    # Increment PATCH version

Automated Versioning

Automated tools or scripts can also be used to manage version increments, ensuring consistency and reducing manual errors, which is enforced in blockles created using Create Blocklet.

Best Practices

  • Version on Release: Always update the Blocklet version before a new release to reflect changes accurately.
  • Changelog: Maintain a changelog to document each version's changes, helping users understand what's new or fixed.