0.10 docs

Author: samirelanduk

README.rst

@@ -117,6 +117,8 @@ customise the execution with various options:
 
 * ``trace`` - A filename for a trace file to generate. This will be an TSV file containing runtime information about the pipeline execution.
 
+* ``resume`` - Whether to resume an existing execution. Can be ``True`` or the UUID of an existing execution to resume from.
+
 
 Custom Runners
 ~~~~~~~~~~~~~~
@@ -167,6 +169,8 @@ properties for:
 
 * ``identifier`` - The unique ID of that run, generated by Nextflow.
 
+* ``uuid`` - The unique UUID of the session, generated by Nextflow.
+
 * ``started`` - When the pipeline ran (as a Python datetime).
 
 * ``finished`` - When the pipeline completed (as a Python datetime).
@@ -221,6 +225,8 @@ following properties:
 
 * ``bash`` - the bash file contents generated for the process execution.
 
+* ``cached`` - whether the process execution was cached.
+
 Process executions can have various files passed to them, and will create files
 during their execution too. These can be obtained as follows:
 
@@ -238,6 +244,15 @@ during their execution too. These can be obtained as follows:
 Changelog
 ---------
 
+Release 0.10.0
+~~~~~~~~~~~~~~
+
+`20th March, 2025`
+
+* Added support for execution resuming.
+* You can now specify separate paths for the log file and work directory.
+
+
 Release 0.9.0
 ~~~~~~~~~~~~~
 

docs/source/changelog.rst

@@ -1,6 +1,15 @@
 Changelog
 ---------
 
+Release 0.10.0
+~~~~~~~~~~~~~~
+
+`20th March, 2025`
+
+* Added support for execution resuming.
+* You can now specify separate paths for the log file and work directory.
+
+
 Release 0.9.0
 ~~~~~~~~~~~~~
 

docs/source/overview.rst

@@ -37,6 +37,8 @@ customise the execution with various options:
 
 * ``trace`` - A filename for a trace file to generate. This will be an TSV file containing runtime information about the pipeline execution.
 
+* ``resume`` - Whether to resume an existing execution. Can be ``True`` or the UUID of an existing execution to resume from.
+
 
 Custom Runners
 ~~~~~~~~~~~~~~
@@ -87,6 +89,8 @@ properties for:
 
 * ``identifier`` - The unique ID of that run, generated by Nextflow.
 
+* ``uuid`` - The unique UUID of the session, generated by Nextflow.
+
 * ``started`` - When the pipeline ran (as a Python datetime).
 
 * ``finished`` - When the pipeline completed (as a Python datetime).
@@ -141,6 +145,8 @@ following properties:
 
 * ``bash`` - the bash file contents generated for the process execution.
 
+* ``cached`` - whether the process execution was cached.
+
 Process executions can have various files passed to them, and will create files
 during their execution too. These can be obtained as follows: