Activiti


Homepage:

Activiti is a light-weight workflow and Business Process Management (BPM) Platform targeted at business people, developers and system admins. Its core is a super-fast and rock-solid BPMN 2 process engine for Java. It's open-source and distributed under the Apache license. Activiti runs in any Java application, on a server, on a cluster or in the cloud. It integrates perfectly with Spring, it is extremely lightweight and based on simple concepts.

\***\*NOTE: We moved to the master branch all the content of the development branch that we were using to design and code the next major version of the project. If you want to contribute with version 6.x please look at the 6.x branch.\*\***

If you want to read more about our Repositories structure you can read our GitBook.

Configuring IntelliJ

• Force language level 21, to fail-fast when (accidentally) using features available only in newer Java versions.

- Open menu _File_, menu item _Project Structure_ - Click list item _Modules_, for each module, tab _Sources_, combobox _Language level_ should be automatically set to 21 ...

• Avoid that changes in some resources are ignored in the next run/debug (and you are forced to use mvn)

- Open menu _File_, menu item _Settings_ or menu _IntelliJ IDEA_, menu item _Preferences..._ if on a Mac - Click tree item _Compiler_, textfield _Resource patterns_: change to !?*.java (remove other content)

• Avoid a StackOverflowError when building

- Open menu _File_, menu item _Settings_ or menu _IntelliJ IDEA_, menu item _Preferences..._ if on a Mac - Click tree item _Compiler_, tree item _Java Compiler_, textfield _Additional command line parameters_ - Add -J-Xss1024k

• Recommended code style: use the Google Java Style Guide with editorconfig

- Download the IntelliJ code style xml from: [https://google.github.io/styleguide/intellij-java-google-style.xml] - Open menu _File_, menu item _Settings_ or menu _IntelliJ IDEA_, menu item _Preferences..._ if on a Mac - Click tree item _Code Style_, click cogwheel and select _Import scheme_, then _IntelliJ code style xml_ - Browse where you downloaded the xml and open it. Check that GoogleStyle is the active scheme. - Note: IntelliJ IDEA doesn't format your code automatically. You have to press Ctrl+Alt+L keyboard combination to trigger auto formatting when coding is done. - There's an .editorconfig what has definition for indents, file encoding, line endings. - If you disable it, you need to set the file encoding and number of spaces correctly manually. - Eclipse code style xml: [https://google.github.io/styleguide/eclipse-java-google-style.xml] - Eclipse needs editorconfig-eclipse plugin in order to support EditorConfig files.

• Set manually the correct file encoding (UTF-8 except for properties files) and end-of-line characters (unix):

- Open menu _File_, menu item _Settings_ or menu _IntelliJ IDEA_, menu item _Preferences..._ if on a Mac - Click tree item _Code Style_, tree item _General_ - Combobox _Line separator (for new files)_: Unix - Click tree item _File Encodings_ - Combobox _Global Encoding_: UTF-8 - Combobox _Default encoding for properties files_: ISO-8859-1 - Note: normal i18n properties files must be in ISO-8859-1 as specified by the java ResourceBundle contract.

• Set manually the correct number of spaces when pressing tab:

- Open menu _File_, menu item _Settings_ or menu _IntelliJ IDEA_, menu item _Preferences..._ if on a Mac - Click tree item _Code Style_, tree item _General_ - Click tab _Java_ - Checkbox _Use tab character_: off - Textfield _Tab size_: 4 - Textfield _Indent_: 4 - Textfield _Continuation indent_: 8 - Open tab _XML_ - Checkbox _Use tab character_: off - Textfield _Tab size_: 2 - Textfield _Indent_: 2 - Textfield _Continuation indent_: 4

• Set the correct file headers (do not include @author or a meaningless javadoc):

- Open menu _File_, menu item _Settings_ or menu _IntelliJ IDEA_, menu item _Preferences..._ if on a Mac - Click tree item _File templates_, tab _Includes_, list item File Header - Remove the line _@author Your Name_. - We do not accept @author lines in source files, see FAQ below. - Remove the entire javadoc as automatically templated data is meaningless.

• Set the correct license header

- Open menu _File_, menu item _Settings_ or menu _IntelliJ IDEA_, menu item _Preferences..._ if on a Mac - Click tree item _Copyright_, tree item _Copyright profiles_ - Click import button to import the _Copyright profile_ - Select the file: [Alfresco_Software.xml](./ide-configuration/intellij-configuration/copyright/Alfresco_Software.xml) - Click tree item _Copyright_ - Combobox _Default project copyright_: Alfresco Software

FAQ

• Why do you not accept @author lines in your source code?

- Because the author tags in the java files are a maintenance nightmare - A large percentage is wrong, incomplete or inaccurate. - Most of the time, it only contains the original author. Many files are completely refactored/expanded by other authors. - Git is accurate, that is the canonical source to find the correct author.

- Because the author tags promote _code ownership_, which is bad in the long run.
- If people work on a piece they perceive as being owned by someone else, they tend to:
- only fix what they are assigned to fix, instead of everything that's broken
- discard responsibility if that code doesn't work properly
- be scared of stepping on the feet of the owner.

- Credit to the authors is given:
- with Open Hub which also has statistics
- in the GitHub web interface.

Development commands

Add License header

To format files with the required license:

bash
mvn license:format

Checkstyle

To check if your code style respect all the rules:

bash
mvn checkstyle:check -DskipCheckstyle=false

Site

To generate the maven site:

bash
mvn clean site site:stage

the site will be generated at: target/staging/index.html

CI/CD

Running on GH Actions.

For Dependabot PRs to be validated by CI, the label "CI" should be added to the PR.

Requires the following secrets to be set:

| Name | Description |
| ---------------------------- | ---------------------------------- |
| BOT_GITHUB_TOKEN | Token to launch other builds on GH |
| BOT_GITHUB_USERNAME | Username to issue propagation PRs |
| NEXUS_USERNAME | Internal Maven repository username |
| NEXUS_PASSWORD | Internal Maven repository password |
| SLACK_NOTIFICATION_BOT_TOKEN | Token to notify slack on failure |

Collapse