Skip to content

run

Execute tasks against repositories.

"run" executes all tasks in the given task file(s).
It first lists all repositories from the source, for example GitHub or GitLab.
Then it modifies a repository by executing the actions of a task if the filters
of that task match.
If files have been modified, it creates a pull request for the repository.

Examples:

# Execute task in file "task.yaml" against all repositories.
saturn run task.yaml

# Execute tasks in files "task1.yaml" and "task2.yaml"
# against all repositories.
saturn run \
  task1.yaml \
  task2.yaml

# Globbing support.
saturn run *.yaml

# Execute task in file "task.yaml" against
# repository "codeberg.org/saturn-sync/saturn-example".
saturn run \
  --repository codeberg.org/saturn-sync/saturn-example \
  task.yaml

# Set inputs "version" and "date".
# The task in file "task.yaml" defines the expected inputs.
saturn run \
  --input version=1.2.3 \
  --input date=2024-11-10 \
  task.yaml

Usage:
  saturn run FILE [FILE...] [flags]

Flags:
      --config string            Path to config file
  -h, --help                     help for run
      --input stringToString     Key/value pair in the format <key>=<value>
                                 to use as an input parameter of a task.
                                 Can be supplied multiple times to set multiple inputs. (default [])
      --repository stringArray   Name of a repository to apply the tasks to.
                                 Filters of a task aren't executed if this flag
                                 is set.
                                 Can be supplied multiple times.