summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRoman Smrž <roman.smrz@seznam.cz>2025-01-25 13:38:25 +0100
committerRoman Smrž <roman.smrz@seznam.cz>2025-01-25 17:40:51 +0100
commitee40ac07057f376d71312f62f7a8225798303852 (patch)
treea4d90d26c7eacd39d1d15748eb46f36590e82bd7 /README.md
parent494f99b478ed8628a62d20b3c37557702c699306 (diff)
Update documentation for run options to watch branches/tags
Changelog: Added `--new-commits-on` and `--new-tags` options for `run` command to dynamically generate jobs based on branch/tags changes
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 17 insertions, 2 deletions
diff --git a/README.md b/README.md
index abd0500..80dca34 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ Job definition
--------------
The top-level elements of the YAML file are `job <name>` defining steps to
-perform the job and potentially listing artefacts produced or required.
+perform the job and potentially listing artifacts produced or required.
Example:
@@ -52,12 +52,27 @@ To run jobs for a git commit range:
minici run <commit>..<commit>
```
+or:
+```
+minici run --range=<commit>..<commit>
+```
+
To run jobs for commits that are in local `<branch>`, but not yet in its upstream:
```
minici run <branch>
```
-For currently branch, the name can be omitted:
+For current branch, the name can be omitted:
```
minici run
```
+
+To watch changes on given `<branch>` and run jobs for each new commit:
+```
+minici run --new-commits-on=<branch>
+```
+
+To watch new tags and run jobs for each tag matching given pattern:
+```
+minici run --new-tags=<pattern>
+```