Skip to content

This project contains a maven archetype which help creating a new Bonita actor filter project.

License

Notifications You must be signed in to change notification settings

bonitasoft/bonita-actorfilter-archetype

Repository files navigation

Actions Status GitHub release Maven Central License: GPL v2

Bonita Actor filter Archetype

This project contains a maven archetype, which allow to easily setup a Bonita actor filter project.

Setup an extension project using the archetype

⚠️ Java 11 is required for Bonita 7.13+

You can setup a Bonita actor filter project using the following command, from a terminal:

Make sure that you do not launch the command from an existing maven project.

mvn archetype:generate -DarchetypeGroupId=org.bonitasoft.archetypes -DarchetypeArtifactId=bonita-actorfilter-archetype
  • archetypeGroupId: the group id of the actor filter archetype.
  • archetypeArtifactId: the artifact id of the actor filter archetype.
  • archetypeVersion: the version of the actor filter archetype.

You'll then have to specify interactively the properties of your project:

  • groupId: the group id of your actor filter
  • artifactId: the artifact id of your actor filter
    • Must match the following regex: ^[a-zA-Z0-9\-]+$
    • Example: my-actor-filter
  • version: the version of your actor filter (default value: 1.0-SNAPSHOT)
  • package the package in which the actor filter source files will be created (default value: the group id of the actor filter)
  • bonitaVersion: the targeted Bonita version
  • className: the class name of your actor filter
    • Must match the following regex: ^[a-zA-Z_$][a-zA-Z\d_$]+$ (A Java classname valid identifier)
    • Example: MyActorfilter1
  • language: the language used in the actor filter project. Available values:
    • java
    • groovy
    • kotlin
  • wrapper (optional): install a maven wrapper. Available values:
    • true (default)
    • false

A folder named [your artifact id] is created, with your Bonita actor filter project, ready to use.

⚠️ You can avoid the interactive mode by specifying all properties of your project directly in the command line, but by doing that you'll bypass the validation performed on the properties content.

Building the archetype

The archetype can be installed in your local maven repository.

  1. Clone this project
  2. From a terminal, enter the following command at the root of the cloned project:
./mvnw clean install

The archetype is now installed on your local maven repository, and is ready to be used.

Contributing

Please sign the contributor license agreement and read our contribution guidelines before to open a pull request.

CLA assistant

Release this project

A github action is used to perform release :

Actions Status

  • This action is triggered when a push is performed on a branch 'release-xxx'
  • It generates the changelog since the last release, creates the github tag and release with the changelog as description, and push the release on our nexus repository.

So, to release a new version of the project, you have to:

  • Create a branch release-[version] on your local git repository
  • Update the version in the pom.xml (remove the -SNAPSHOT)
  • Push the branch

⚠️ Make sur that the release branch is final before to push it. If you have to update something on the release branch after the push, then you must first:

  • Delete the tag and the release on github
  • Remove the artifact from our nexus repository