Categories: RELEASE

Step Keyword API Release Strategy

Overview

The Step Keyword API is maintained and versioned independently of the Step platform. This independent versioning allows for more flexible updates and backward compatibility across different Step versions.

Versioning Scheme

The Keyword API follows semantic versioning with the format: MAJOR.MINOR.PATCH

  • Major version: Significant API changes or breaking changes
  • Minor version: New features and enhancements
  • Patch version: Bug fixes and minor improvements

Independent Versioning

The Keyword API uses a single version across all supported programming languages (Java, .NET, Node.js). However, this version is maintained independently from the Step platform release cycle.

This independence provides key benefits:

  • Backward compatibility: Older keywords continue to run on newer platform versions without requiring recompilation.
  • Clear feature visibility for keyword developers: A new API version signals precisely when new capabilities are available, without being tied to platform release cadence.

Compatibility Matrix

Each Keyword API release specifies the minimum Step version required. For detailed compatibility information and current versions, refer to the Keyword API Release Notes.

Development Resources

To develop keywords using the Keyword API:

Maven Artifacts

The Java Keyword API is available on Maven Central. For the latest version and artifact details, see the Keyword API Release Notes.

<dependency>
    <groupId>ch.exense.step</groupId>
    <artifactId>step-functions-api</artifactId>
    <version><!-- See release notes for latest version --></version>
</dependency>

Support and Migration

When upgrading the Keyword API:

  1. Review the release notes for breaking changes
  2. Update dependencies in your project
  3. Recompile and redeploy your keywords
  4. Test with your existing keywords

For questions or issues:

See Also