Adds COMPI_PIPELINE_VERSION to tasks environment variables

Author: hlfernandez

cli/pom.xml

@@ -9,7 +9,7 @@
 	<parent>
 		<groupId>org.sing_group</groupId>
 		<artifactId>compi</artifactId>
-		<version>1.5.0</version>
+		<version>1.5.1</version>
 		<!--
 			WARNING: change version using (in the parent project):
 			mvn versions:set -DnewVersion=[new_version]

core/pom.xml

@@ -10,7 +10,7 @@
 	<parent>
 		<groupId>org.sing_group</groupId>
 		<artifactId>compi</artifactId>
-		<version>1.5.0</version>
+		<version>1.5.1</version>
 		<!--
 			WARNING: change version using (in the parent project):
 			mvn versions:set -DnewVersion=[new_version]

core/src/main/java/org/sing_group/compi/core/CompiRunConfiguration.java

@@ -73,6 +73,10 @@ public Map<String, String> asMap() {
       CONFIGURATION_VARIABLES_PREFIX + "PIPELINE_FILE",
       (this.getPipelineFile() == null) ? "" : this.getPipelineFile().toString()
     );
+    asMap.put(
+      CONFIGURATION_VARIABLES_PREFIX + "PIPELINE_VERSION",
+      (this.getPipeline() == null) ? "" : this.getPipeline().getVersion().toString()
+    );
     asMap.put(
       CONFIGURATION_VARIABLES_PREFIX + "PARAMS_FILE",
       (this.getParamsFile() == null) ? "" : this.getParamsFile().toString()

dk/pom.xml

@@ -9,7 +9,7 @@
 	<parent>
 		<groupId>org.sing_group</groupId>
 		<artifactId>compi</artifactId>
-		<version>1.5.0</version>
+		<version>1.5.1</version>
 		<!--
 			WARNING: change version using (in the parent project):
 			mvn versions:set -DnewVersion=[new_version]

docs/source/writing_pipelines.rst

@@ -264,7 +264,37 @@ first ``foreach``.
 .. note::
     It is mandatory that all ``foreach`` tasks have the same number of iterations
     if you want to establish an "iteration dependency" between them.
-  
+
+Environment variables available for tasks
+-----------------------------------------
+
+When launching a task, Compi establishes a set of environment variables related with the task
+and the Compi execution itself (i.e. the ``compi run`` command), plus an additional variable 
+with the pipeline version (``COMPI_PIPELINE_VERSION``).
+
+The task-related variables are:
+
+- ``task_id``: contains the id of the task being executed.
+- ``task_code``: contains the code (defined in the ``pipeline.xml``) of the task being executed.
+- ``task_params``: contains the list of params associated to the task being executed.
+- ``i``: in the case of ``foreach`` tasks, the iteration value.
+
+The variables related with the Compi execution are:
+
+- ``COMPI_PARAMS_FILE``
+- ``COMPI_DO_NOT_LOG_TASKS``
+- ``COMPI_UNTIL_TASK``
+- ``COMPI_MAX_TASKS``
+- ``COMPI_AFTER_TASKS``
+- ``COMPI_BEFORE_TASK``
+- ``COMPI_LOGS_DIR``
+- ``COMPI_PIPELINE_FILE``
+- ``COMPI_RUNNERS_FILE``
+- ``COMPI_FROM_TASKS``
+- ``COMPI_SINGLE_TASK``
+- ``COMPI_LOG_ONLY_TASKS``
+- ``COMPI_SHOW_STD_OUTS``
+- ``COMPI_OVERWRITE_LOGS``
 
 Defining tasks metadata
 =======================

e2e-tests/pom.xml

@@ -9,7 +9,7 @@
 	<parent>
 		<groupId>org.sing_group</groupId>
 		<artifactId>compi</artifactId>
-		<version>1.5.0</version>
+		<version>1.5.1</version>
 		<!--
 			WARNING: change version using (in the parent project):
 			mvn versions:set -DnewVersion=[new_version]

pom.xml

@@ -6,7 +6,7 @@
 	<groupId>org.sing_group</groupId>
 	<artifactId>compi</artifactId>
 	<packaging>pom</packaging>
-	<version>1.5.0</version>
+	<version>1.5.1</version>
 	<!-- WARNING: change version using (in the parent project): mvn versions:set -DnewVersion=[new_version] mvn versions:commit This will change the version
 		in all modules at-once -->