Skip to main content

Connector Versions Management

Version connector releases so developers and users can identify changes and plan upgrades.

Versioning​

  • Use semantic versioning (MAJOR.MINOR.PATCH) for connector software releases.
  • Increment the major version for incompatible behavior or contract changes, the minor version for backward-compatible features, and the patch version for backward-compatible fixes.
  • Keep the connector's registration metadata and documentation aligned with the release users can install.

The registration contract includes an optional manifest_version field. It identifies the manifest format/version; do not assume it automatically versions connector software or enforces compatibility with Adspire. Use the connector's release process to communicate the software version unless the platform provides a dedicated version field.

Deprecation and upgrades​

  • Announce breaking changes and deprecations before removing or changing supported behavior.
  • Document migration steps and any action required from users.
  • Keep existing installations working during a reasonable migration window where practical.
  • Do not silently remove capabilities that active installations depend on.

The connector definition's approval status is separate from its release version and from the active status of individual installations. See Connector Installation Lifecycle for registration, review, installation, and uninstall states.