Skip to content

Commit

Permalink
Rename CCE module to functions
Browse files Browse the repository at this point in the history
  • Loading branch information
nterray authored and Gashmob committed Jan 30, 2024
1 parent 2b66317 commit 4f06b7c
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Please contact your salesperson to receive your credentials.
tuleap-plugin-pullrequest \
tuleap-plugin-roadmap \
tuleap-plugin-svn \
tuleap-plugin-tracker-cee \
tuleap-plugin-tracker-functions \
tuleap-plugin-taskboard \
tuleap-plugin-testmanagement \
tuleap-plugin-testplan \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Project management:

* This module is part of :ref:`Tuleap Entreprise <tuleap-enterprise>`.

* :ref:`tracker-cee <tracker-cce>`: Execute custom code after each artifact creation/update.
* :ref:`tracker-functions <tracker-functions>`: Execute custom code after each artifact creation/update.

* This module is part of :ref:`Tuleap Entreprise <tuleap-enterprise>`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ sections:
configuration/workflow
configuration/field-dependencies
configuration/webhooks
configuration/cce
configuration/functions
configuration/general-configuration
configuration/notifications
configuration/import
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _tracker-cce:
.. _tracker-functions:

Tracker Custom Code Execution
=============================
Tuleap Functions for Tracker
============================

.. note::

Expand All @@ -12,20 +12,20 @@ The goal of this feature is to let project administrator do a level of computati
created or updated. For instance, this could be used to compute a risk as a combination of two factors. This is an
alternative to the model where team have to rely on webhook and an external server to do their own computation.

The custom code is a `WebAssembly <https://webassembly.org/>`_ module built with WASI Preview 1 support and uploaded
The custom code is a `WebAssembly <https://webassembly.org/>`_ function built with WASI Preview 1 support and uploaded
by the tracker administrator. It is run asynchronously by Tuleap after each artifact creation/update.

* The payload sent to the module via stdin is the same as the one for :ref:`the tracker webhook <webhook-tracker>`.
* The module must output (stdout) a payload identical to the one that is used by REST API to update an artifact (``PUT /artifact/:id``).
* The artifact will be updated with this output payload (update fields and/or add a follow-up comment) with a dedicated "Custom Code Execution" user.
* The payload sent to the function via stdin is the same as the one for :ref:`the tracker webhook <webhook-tracker>`.
* The function must output (stdout) a payload identical to the one that is used by REST API to update an artifact (``PUT /artifact/:id``).
* The artifact will be updated with this output payload (update fields and/or add a follow-up comment) with a dedicated "Tuleap Functions" user.

You can take a look at `this example <https://github.com/Enalean/tuleap-functions-for-tracker-example>`_ to have a better understanding of how to build such module.
You can take a look at `this example <https://github.com/Enalean/tuleap-functions-for-tracker-example>`_ to have a better understanding of how to build such function.

Please note that:

* Module is sandboxed and has a limited access to resources. For example it is not possible to read the content of file attachments of the artifact.
* There is only one module per tracker.
* The size of the module is limited to 10MB.
* Execution of the module can be suspended (module is there but not executed).
* Function is sandboxed and has a limited access to resources. For example it is not possible to read the content of file attachments of the artifact.
* There is only one function per tracker.
* The size of the function is limited to 10MB.
* Execution of the function can be suspended (function is there but not executed).
* For each tracker, the last 50 execution details (status, errors) are kept with: associated artifact, source payload and generated payload.
* To avoid infinite loop, the update done by a custom code execution will not trigger another custom code execution.
2 changes: 1 addition & 1 deletion languages/en/user-guide/tuleap-entreprise.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Project management
* :ref:`Test Management <testmgmt>`: Test campaigns and traceability (aka TTM).
* :ref:`Timetracking <timetracking>`: Provide an easy way to track your time
* :ref:`Velocity <plugin_velocity>`: Display velocity chart in the :ref:`backlog`
* :ref:`Tracker Custom Code Execution <tracker-cce>`: Execute custom code after each artifact creation/update
* :ref:`Tuleap Functions for Tracker <tracker-functions>`: Execute custom code after each artifact creation/update

Authentication and permissions
------------------------------
Expand Down

0 comments on commit 4f06b7c

Please sign in to comment.