This post is intended for early adopters using the Axon Ivy PRO Designer 14 Preview VS Code extension.
Once Axon Ivy LTS 14 is released, the sprint setup instructions in this post will no longer apply.
When developing with the VS Code extension, there are four main components that can change:
- VS Code: Managed independently of Axon Ivy. We recommend using the latest stable release.
- Axon Ivy VS Code extension: We recommend using the latest version. If you encounter issues, you can easily revert to an earlier version using the VS Code command
Extensions: Install Specific Version of Extension....
- Axon Ivy Engine: Downloaded and started automatically by the extension. By default, it uses the latest nightly release, which changes daily and may introduce breaking changes.
- Axon Ivy Java API: (for example,
com.axonivy.ivy.api:ivy-api), by default, projects use the 14.0.0-SNAPSHOT version, which is also under active development and change frequently.
Switch your development setup to a sprint release
To align your development environment with a specific sprint release, update both the Axon Ivy Engine and the Axon Ivy Java API.
Axon Ivy Engine
In your workspace, run the command:
Axon Ivy: Switch Engine release train
Select sprint as the release train.
To verify that the correct engine is running, check the extension's output log. In the example below, the engine has been switched to Sprint 29 (S29). Currently, S30 is the latest sprint release.
Axon Ivy Java API
Update your project's pom.xml so that the parent version matches the sprint release of the engine. For Sprint 30, use version 14.0.0-m30:
<parent>
<groupId>com.axonivy.ivy.api</groupId>
<artifactId>ivy-project-parent</artifactId>
<version>14.0.0-m30</version>
<relativePath></relativePath>
</parent>
Finally, update the Project Build Plugin version to:
<plugin>
<groupId>com.axonivy.ivy.ci</groupId>
<artifactId>project-build-plugin</artifactId>
<version>${project.parent.version}</version>
</plugin>
After these changes, your project will use the same sprint version for both the engine and the Java API, ensuring they remain compatible.
Axon Ivy Engine Docker Image
Use the sprint tag of the Axon Ivy Engine image, if you want to deploy sprint-based projects on a running Axon Ivy Engine.
docker run -p 8080:8080 axonivy/axonivy-engine:sprint
