This post is intended for early adopters using the Axon Ivy PRO Designer 14 Preview VS Code extension.
The following setup instructions specifically apply to the version 14 milestone 31 release. Once Axon Ivy LTS 14 is released, there is a simplified milestone setup in place, as described here: Part 2 - Developing in VS Code with a milestone release.
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 milestone release
To align your development environment with a specific milestone release, fix versions in:
- VSCode-Designer extension
- AxonIvy Engine
- AxonIvy JavaApi
The version of the latest milestone release is always listed on our website: https://dev.axonivy.com/download/milestone
VSCode-Designer
Install the vscode-designer version that aligns with the milestone 31 you want to use.
- Run the command:
Extensions: Install Specific Version of Extension....
- Select 'Axon Ivy Pro Designer 14'
- Pick the version that ends with your milestone number 31, e.g.
14.0.31
Axon Ivy Engine
To make sure the milestone 31 engine is started, you must manually download the milestone 31 engine and specify the path to the engine in VS Code:
- Download the right engine from the archive download page. Chose either
AxonIvyEngine14.0.0.2608131541.m31_Windows_x64.zip if you're on Windows or AxonIvyEngine14.0.0.2608131541.m31_Slim_All_x64.zip if you use MacOS/Linux.
- Unzip the downloaded file. There should now be a folder starting with
AxonIvyEngine14.0.0.2608131541.m31 in your download directory.
- With your file explorer, copy the full path to that folder:
- Switch to your VS Code Workspace where you have the milestone 31 extension version installed from the previous section.
- Run the command
Preferences: Open Settings (UI)
- Search for
@ext:axonivy.vscode-designer-14
- Switch to the
Workspace tab
- Activate
Run by Extension and copy the full file path of the unzipped folder to Release Train
- Run the command
Developer: Reload Window to restart the extension
To verify that the correct engine is running, check the extension's output log. In the example below, the engine that has been started by the extension is the correct m31 one.
Axon Ivy Java API
Update your project's pom.xml so that the parent version matches the milestone release of the engine. For Milestone 31, use version 14.0.0-m31:
<parent>
<groupId>com.axonivy.ivy.api</groupId>
<artifactId>ivy-project-parent</artifactId>
<version>14.0.0-m31-SNAPSHOT</version>
<relativePath></relativePath>
</parent>
After these changes, your project will use the same sprint version for both the engine and the Java API, ensuring they remain compatible.
You can update all projects at once with the 'mvn' CLI in your reactor-root, by firing this command:
qualified=14.0.0-m31-SNAPSHOT
mvn org.codehaus.mojo:versions-maven-plugin:2.21.0:update-parent \
-DparentVersion="${qualified}" \
-DskipResolution=true \
-DgenerateBackupPoms=false
Axon Ivy Engine Docker Image
Use the specific milestone tag of the Axon Ivy Engine image, if you want to deploy milestone-based projects on a running Axon Ivy Engine.
# use latest milestone
docker run -p 8080:8080 axonivy/axonivy-engine:milestone
# use specific milestone
docker run -p 8080:8080 axonivy/axonivy-engine:14.0.0-m31
