Rulesets

Learn about rulesets.

The ruleset allows you to provide conditions to limit the execution of the container.

When you push your code to a source control management system a payload is sent to Vela.

Within that payload contains characteristics about what just happened. Maybe it was a push to the main branch, feature branch or tag on any specific commit.

The ruleset key gives you the ability to add conditions on the step to tell Vela when this step should be executed.

- name: Welcome
  # This ruleset would scope the step to only executing
  # under the conditions a push to the main branch occurred
  ruleset:
    event: push
    branch: main
  image: alpine
  commands:
    - echo "Welcome to the Vela docs"
- name: Welcome
  # This ruleset would scope the step to never executing
  # under the conditions a push to the main branch occurred
  ruleset:
    unless:
      event: push
      branch: main
  image: alpine
  commands:
    - echo "Welcome to the Vela docs"

Key references:

name:, ruleset:,image:, commands:,