Skip to content

Commit

Permalink
docs(content/mig-guide): migration to HeroDevs XLTS libraries (#1709)
Browse files Browse the repository at this point in the history
related to: camunda/camunda-bpm-platform#4549

---------

Co-authored-by: tasso94 <3015690+tasso94@users.noreply.github.com>
  • Loading branch information
venetrius and tasso94 authored Nov 26, 2024
1 parent 923ebfa commit 7aed4cc
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 8 deletions.
17 changes: 12 additions & 5 deletions content/introduction/third-party-libraries/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,25 @@ menu:

---

This section covers third party libraries and their use in Camunda. It provides license books (see sub pages) that list the third-party dependencies that Camunda distributes along with its code. Our license books include the library name, version, copyright notices, and licenses under which we use the library. By downloading and using Camunda 7, you agree to adhere to these licenses.

For selected third-party libraries that we consider especially noteworthy, this page describes their license terms and use in the Camunda 7 artifacts.
This section covers third-party libraries and their use in Camunda. It provides the license book that lists the third-party dependencies that Camunda distributes along with its code.

For legal reference and any other license-related aspects please refer to [Licences]({{< ref "/introduction/licenses.md" >}}).


# Web Applications (Cockpit, Tasklist, Admin)

## XLTS for AngularJS
Starting with versions 7.18.0-alpha2, 7.17.2, 7.16.9, 7.15.15 and up to including 7.20.8, 7.21.5, 7.22.0, and 7.23.0-alpha1 the Camunda web applications used a set of third-party libraries provided by XLTS.dev

You can find our rationale for using long-term support libraries in [our blog post on ensuring the long-term maintenance of Camunda 7](https://camunda.com/blog/2022/02/ensuring-continuous-support-of-angularjs-in-camunda-platform-7-17/).

Starting with versions 7.18.0-alpha2, 7.17.2, 7.16.9, 7.15.15, the Camunda web applications use a set of third-party libraries referred to as *XLTS for AngularJS* (technical names: `angular`, `angular-animate`, `angular-cookies`, `angular-loader`, `angular-mocks`, `angular-resource`, `angular-route`, `angular-sanitize`, `angular-touch`). XLTS for AngularJS follows a proprietary license called *EULA for the downstream recipient of XLTS for AngularJS* (short *XLTS for AngularJS – EULA*) that you can find [here](https://xlts.dev/angularjs/downstream-eula).
## Bootstrap NES and AngularJS NES by HeroDevs, Inc.
Starting with versions 7.20.9, 7.21.6, 7.22.1, and 7.23.0-alpha2 the Camunda web applications use a set of third-party libraries provided by HeroDevs, Inc.:

This license imposes restrictions around distributing and reverse-engineering XLTS for AngularJS independently of Camunda artifacts. The license does otherwise not restrict how you can use and distribute the Camunda artifacts that include XLTS for AngularJS. You can find our rationale for using this library in [our blog post on ensuring the long-term maintenance of Camunda 7](https://camunda.com/blog/2022/02/ensuring-continuous-support-of-angularjs-in-camunda-platform-7-17/).
* *AngularJS* (technical names: `angular`, `angular-animate`, `angular-cookies`, `angular-loader`, `angular-mocks`, `angular-resource`, `angular-route`, `angular-sanitize`, `angular-touch`)
* *angular-ui-bootstrap*
* *angular-translate*
* *angular-moment*
* *Bootstrap*

Where AngularJS, angular-ui-bootstrap, angular-translate, angular-moment, and Bootstrap were licensed entirely under the MIT license, Bootstrap NES and AngularJS NES by HeroDevs, Inc. licenses additional parts under the HeroDevs NES License. By downloading and using Camunda with Bootstrap NES and AngularJS NES by HeroDevs, Inc., you agree to the terms of the HeroDevs NES License. You can find the HeroDevs NES License terms in our [License Book]({{< ref "/introduction/third-party-libraries/camunda-bpm-platform-license-book.md" >}}).
19 changes: 17 additions & 2 deletions content/update/minor/722-to-723/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ menu:

This document guides you through the update from Camunda `7.22.x` to `7.23.0` and covers the following use cases:

1. For developers: [Set Variables Async API](#Set Variables Async API)
1. For developers: [Set Variables Async API](#set-variables-async-api)
1. For administrators and developers: [Bootstrap NES and AngularJS NES by HeroDevs, Inc.](#bootstrap-nes-and-angularjs-nes-by-herodevs-inc)

This guide covers mandatory migration steps and optional considerations for the initial configuration of new functionality included in Camunda 7.23.

Expand All @@ -25,4 +26,18 @@ Before version 7.22.1, the Set Variables Async API failed whenever at least one

Starting with version 7.22.1, the behavior has changed: if any of the process instances was deleted or completed, the call will still succeed. As a consequence, the Set Variables Batch Operation will also succeed in this case.

Please note that this does not apply to the Sync API, which keeps its behavior and fails if the process instance does not exist.
Please note that this does not apply to the Sync API, which keeps its behavior and fails if the process instance does not exist.

# Bootstrap NES and AngularJS NES by HeroDevs, Inc.

Camunda 7.23.0 replaces the following libraries with versions of Bootstrap NES and AngularJS NES by HeroDevs, Inc.:

* *AngularJS* (technical names: `angular`, `angular-animate`, `angular-cookies`, `angular-loader`, `angular-mocks`, `angular-resource`, `angular-route`, `angular-sanitize`, `angular-touch`)
* *angular-ui-bootstrap*
* *angular-translate*
* *angular-moment*
* *Bootstrap*

Where AngularJS, angular-ui-bootstrap, angular-translate, angular-moment, and Bootstrap were licensed entirely under the MIT license, Bootstrap NES and AngularJS NES by HeroDevs, Inc. licenses additional parts under the HeroDevs NES License. By downloading and using Camunda with Bootstrap NES and AngularJS NES by HeroDevs, Inc., you agree to the terms of the HeroDevs NES License. You can find the HeroDevs NES License terms in our [License Book]({{< ref "/introduction/third-party-libraries/camunda-bpm-platform-license-book.md" >}}).

Please see our [third-Party libraries documentation]({{< ref "/introduction/third-party-libraries/_index.md#web-applications-cockpit-tasklist-admin" >}}) for details.
16 changes: 15 additions & 1 deletion content/update/patch-level.md
Original file line number Diff line number Diff line change
Expand Up @@ -515,7 +515,7 @@ The following test scenarios fail on Tomcat 10:
* [CdiBeanCallActivityResolutionTest](https://github.com/camunda/camunda-bpm-platform/blob/f37877b822dabcbf3cee5806bd5833d18cdcb543/qa/integration-tests-engine/src/test/java/org/camunda/bpm/integrationtest/functional/cdi/CdiBeanCallActivityResolutionTest.java)
{{< /note >}}

## 7.22.0 to 7.22.1
## 7.22.0 to 7.22.1 / 7.21.5 to 7.21.6 / 7.20.8 to 7.20.9

The 7.22.0 release [replaced the runtime with the historic process instance query]({{< ref "/update/minor/721-to-722/_index.md#cockpit-process-instance-batch-modification" >}}) in Cockpit when performing a [Process Instance Batch Modification][process-instance-modification].

Expand All @@ -538,6 +538,20 @@ Starting with version 7.22.1, the behavior has changed: if any of the process in

Please note that this does not apply to the Sync API, which keeps its behavior and fails if the process instance does not exist.

### Bootstrap NES and AngularJS NES by HeroDevs, Inc.

These patches replace the following libraries with versions of Bootstrap NES and AngularJS NES by HeroDevs, Inc.:

* *AngularJS* (technical names: `angular`, `angular-animate`, `angular-cookies`, `angular-loader`, `angular-mocks`, `angular-resource`, `angular-route`, `angular-sanitize`, `angular-touch`)
* *angular-ui-bootstrap*
* *angular-translate*
* *angular-moment*
* *Bootstrap*

Where AngularJS, angular-ui-bootstrap, angular-translate, angular-moment, and Bootstrap were licensed entirely under the MIT license, Bootstrap NES and AngularJS NES by HeroDevs, Inc. licenses additional parts under the HeroDevs NES License. By downloading and using Camunda with Bootstrap NES and AngularJS NES by HeroDevs, Inc., you agree to the terms of the HeroDevs NES License. You can find the HeroDevs NES License terms in our [License Book]({{< ref "/introduction/third-party-libraries/camunda-bpm-platform-license-book.md" >}}).

Please see our [third-party libraries documentation]({{< ref "/introduction/third-party-libraries/_index.md#web-applications-cockpit-tasklist-admin" >}}) for details.

# Full Distribution

This section is applicable if you installed the [Full Distribution]({{< ref "/introduction/downloading-camunda.md#full-distribution" >}}) with a **shared process engine**. In this case you need to update the libraries and applications installed inside the application server.
Expand Down

0 comments on commit 7aed4cc

Please sign in to comment.