with a few more comments

This commit is contained in:
Kasper Juul Hermansen 2022-08-22 08:46:35 +02:00
parent c0538b6e80
commit d420e53ea8
Signed by: kjuulh
GPG Key ID: 57B6E1465221F912
2 changed files with 25 additions and 1 deletions

View File

@ -1,12 +1,23 @@
# Some version goes here # Some version goes here
# Version of schema to pull, will also determine level of yaml-language-schema
version: "some-upstream-repo-for-ruddle@some-api-version" version: "some-upstream-repo-for-ruddle@some-api-version"
# The name of the service, used when unfolding ruddle, as well as proving tracing on where logs are coming from
name: "ruddle_base_plan" name: "ruddle_base_plan"
# Usually most plugins come from the same registry, as such here we can set a common
implicitProvider: git.front.kjuulh.io implicitProvider: git.front.kjuulh.io
# Plugins / Components, provide either new functionality, or overrides for other plugins.
plugins: plugins:
# ruddle package, comes prepacked with ruddle itself
# global sets variables that are available to all the other plugins and descendants.
# They can either be set inline or be used by child packages. If not added to properties, but not required until the root packages.
ruddle/global@latest: ruddle/global@latest:
# file to look for in child packages for overrides
file: ruddle.yaml # is default, can be omitted file: ruddle.yaml # is default, can be omitted
# path to look for, for overrides
path: org path: org
orgSettings: orgSettings:
- key: "name" - key: "name"
@ -15,21 +26,31 @@ plugins:
required: true required: true
- key: "domain" - key: "domain"
required: false required: false
# Vars are only used in scripts, and is meant to be either environment variables mounted directly
# from existing values, or secrets unwrapped by mozilla/sops
ruddle/vars@latest: ruddle/vars@latest:
path: vars path: vars
vars: vars:
# when dev is provided as arg, this will be used `. ruddle run vars --features=dev`
- when: dev - when: dev
vars: vars:
SOME_VARIABLE: SOME_VALUE SOME_VARIABLE: SOME_VALUE
- when: prod - when: prod
vars: vars:
SOME_VARIABLE: SOME_OTHER_VALUE SOME_VARIABLE:
from_secret:
sops: ruddle_some_variable
# Actions are your bread and butter for providing scripts and actions to your descendants
ruddle/actions@1.0.0: ruddle/actions@1.0.0:
path: actions path: actions
dependsOn: dependsOn:
# Actions usually require an (action-provider) these can be anything between that can execute
# something, in this case shell or dagger, but could also be python, go, rust or something else entirely.
- ruddle/shell@1.0.0 - ruddle/shell@1.0.0
- ruddle/dagger@1.0.0 - ruddle/dagger@1.0.0
# a global path is set for scripts, this means that each script can be implicit and not require specifying a direct path for each of them
basePath: scripts/ basePath: scripts/
scripts: scripts:
notify_team: notify_team:

View File

@ -1,5 +1,8 @@
# Only 1 inheritance allowed (no multiple inheritance)
# The script will inherit all base settings, such as version, plugins and so on.
basedOn: ../base/ruddle.base.yaml # can also be git repo with ruddle.yaml in root basedOn: ../base/ruddle.base.yaml # can also be git repo with ruddle.yaml in root
# inputs are set to fill out details of scripts provided from children
input: input:
org: org:
name: "some-name" name: "some-name"