Commit Conventions¶

This project uses Conventional Commits for automatic versioning with semantic-release.

Format¶

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Types and Version Bumps¶

Examples¶

Patch Release¶

fix: resolve certificate path resolution on Windows

Minor Release¶

feat: add support for multiple namespace encryption

Major Release (Breaking Change)¶

Using ! after the type:

feat!: require kubeseal binary in PATH

Remove fallback to bundled kubeseal binary

Using BREAKING CHANGE footer:

feat: update encryption algorithm

BREAKING CHANGE: Sealed secrets created with older versions
will need to be re-encrypted with the new algorithm.

When to Mark as Breaking Change¶

• Removing or renaming commands or configuration options
• Changing default behavior that users depend on
• Requiring new dependencies or system requirements
• Incompatible data format changes
• Removing support for older versions of tools or platforms

Scoped Commits¶

You can optionally add a scope for more context:

feat(certificates): add certificate expiry warnings
fix(base64): handle multi-line values correctly
docs(readme): update installation instructions