meissa/provs
7
1
Fork 0
Code Issues Pull requests Projects Releases 12 Packages Wiki Activity

update doc

Browse source
This commit is contained in:
ansgarz 2022-04-19 19:37:25 +02:00
parent 494c7fc2d7
commit b0876878f1
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
doc/ForDevelopers.md
View file

@ -8,20 +8,13 @@
This uberjar is a Java jar-file including all required dependencies. This uberjar is a Java jar-file including all required dependencies.
## Call hierarchy
Find below an example of a sequence diagram when provisioning a desktop workplace:
![img.png](resources/provision-workplace-sequence.diagram.png)
## Task ## Task
```kotlin ```kotlin
fun Prov.provisionK8s() = task { /* ... code and subtasks come here ... */ } fun Prov.provisionK8s() = task { /* ... code and subtasks come here ... */ }
``` ```
Very often you'll see a task definition like this in provs and might wonder ... If you're having a deeper look into the provs code, you'll see regularly a task definition like this and might wonder ...
### What is a task ? ### What is a task ?
@ -32,3 +25,10 @@ The success or failure is computed automatically in the following way:
* a **taskWithResult** works the same except that it requires an additional result to be returned which is also included in the success calculation * a **taskWithResult** works the same except that it requires an additional result to be returned which is also included in the success calculation
* a task defined with **optional** (i.e. `= optional { /* ... */ }` always returns success (even if there are failing subtasks) * a task defined with **optional** (i.e. `= optional { /* ... */ }` always returns success (even if there are failing subtasks)
* **requireLast** defines a task which must provide an explicit result and solely this result counts for success calculation * **requireLast** defines a task which must provide an explicit result and solely this result counts for success calculation
## Call hierarchy
Find below an example of a sequence diagram when provisioning a desktop workplace:
![img.png](resources/provision-workplace-sequence.diagram.png)