Skip to content

Getting Started with Flogo Maven Plugin

Jump to bottom
Vijay Nalawade edited this page Mar 24, 2025 · 11 revisions

Running the first app

To get started with the Flogo Maven plugin

  1. Generate the POM File. Refer to Generating the POM File
  2. Open the Terminal/Command Prompt.
  3. Run the Maven Commands
  • mvn compile - This will generate the Flogo binary in the target folder.
  • mvn test - This will run the unit tests defined in the .flogotest file for the App.
  • mvn site - This will generate the reports.
  • mvn package - This will generate the Tibco Platform Build zip file if the deploymentTarget is set to tibco-platform

Changing the properties

The Flogo Maven plugin externalizes all the plugin configuration to Maven properties. You can changes the property value during execution by passing the properties using the -D flag in the syntax -Dproperty=value

For e.g, If your project has two test suites TestSuite1 and TestSuite2 and you want to run only one test suite TestSuite1 then you can run the test command as following

mvn test -DselectiveTestSuites=TestSuite1

Working with Maven plug-in in VSCode

If you are a developer using Flogo VSCode Extension, then the generated pom.xml file will take the flogoVSCodeExtensionPath value automatically from the installed extension.

There is no additional configuration required. The Maven commands will work as-is.

Note: After upgrading the Flogo VSCode Extension, you will need to regenerate the pom.xml. The folder for the older VSCode extension will be deleted after upgradation of extension and a new folder for the upgraded extension will be created. Before regenerating the pom.xml, backup any changes you may have done to properties and any other values as the existing pom.xml will be overwritten with default values.

Working with Maven plug-in in CI/CD pipelines

Once you move to CI/CD pipelines, the Flogo VSCode Extension file (.vsix) file must be available on the build system. This is the same file that you use for installing the Flogo extension in your VS Code.

  1. Download the appropriate .vsix file as per Operating System of your CI/CD pipeline

  2. Either update the value of flogoVSCodeExtensionPath property in application pom.xml to path of downloaded .vsix file or pass the path using the -D flag.

    e.g. mvn compile -DflogoVSCodeExtensionPath=/home/build/flogo-vscode-linux-x64-1.2.0-836.vsix

    In above case, plugin will use provided .vsix file for the app build.

Clone this wiki locally