|
| 1 | +alpine_version: |
| 2 | + description: the Alpine image version |
| 3 | + type: string |
| 4 | + |
| 5 | +publish-token-variable: |
| 6 | + description: > |
| 7 | + the env var containing your publish token. Pass this as a literal string such |
| 8 | + as `$ORB_PUBLISHING_TOKEN`. DO NOT paste the actual token into your |
| 9 | + configuration. If omitted it's assumed the CLI has already been setup |
| 10 | + with a valid token. |
| 11 | + By default, an environment variable `$ORB_PUBLISHING_TOKEN` is expected. |
| 12 | + Make sure to pass a context to this job that contains the variable. |
| 13 | + type: string |
| 14 | + default: "${ORB_PUBLISHING_TOKEN}" |
| 15 | + |
| 16 | +destination-file: |
| 17 | + description: Path including filename of where the packed orb will be written. |
| 18 | + type: string |
| 19 | + default: ./.orbspace/orb.yml |
| 20 | + |
| 21 | +orb-path: |
| 22 | + description: the path to the orb file |
| 23 | + type: string |
| 24 | + |
| 25 | +namespace: |
| 26 | + description: > |
| 27 | + The namespace of your target orb. |
| 28 | + Environment variables from envorbs are accepted. |
| 29 | + By default, the git organization is assumed. |
| 30 | + type: string |
| 31 | + default: "" |
| 32 | + |
| 33 | +orb-name: |
| 34 | + description: > |
| 35 | + The name of your target orb. |
| 36 | + Environment variables from envorbs are accepted. |
| 37 | + By default, the git repository name is assumed. |
| 38 | + type: string |
| 39 | + default: "" |
| 40 | + |
| 41 | +source-dir: |
| 42 | + description: > |
| 43 | + Path to the root of the orb source directory to be packed. |
| 44 | + By default, `src/` is assumed. |
| 45 | + type: string |
| 46 | + default: src/ |
| 47 | + |
| 48 | +store-artifact: |
| 49 | + description: If enabled, the destination-file will be stored as artifact. |
| 50 | + type: boolean |
| 51 | + default: true |
| 52 | + |
| 53 | +patch-environment-variables: |
| 54 | + description: > |
| 55 | + To replace all template variables with the respective environment variables. |
| 56 | + Variables have to be defined in the format `{{"{{"}}.VAR{{"}}"}}`. |
| 57 | + type: boolean |
| 58 | + default: true |
| 59 | + |
| 60 | +patch-parameters: |
| 61 | + description: > |
| 62 | + To patch all crosscutting parameters defined in the src/+parameters.yml file. |
| 63 | + Parameters that are shared among multiple commands, orbs or executors can thereby be shared. |
| 64 | + Define the parameters in the root layer of the +parameters.yml file. |
| 65 | + In every yaml file inside the commands, jobs, or executors folder, the parameters are propagated if they |
| 66 | + are referenced there via << parameters.xyz >>. |
| 67 | + type: boolean |
| 68 | + default: true |
| 69 | + |
| 70 | +success-verification: |
| 71 | + description: define additional post-test-execution checks to verify that the test succeeded |
| 72 | + type: steps |
| 73 | + default: [] |
| 74 | +success-config: |
| 75 | + description: the path to the succeeding test case config that refers to the orb jobs to be tested |
| 76 | + type: string |
| 77 | + default: "" |
| 78 | +fail-verification: |
| 79 | + description: define additional post-test-execution checks to verify that the test failed |
| 80 | + type: steps |
| 81 | + default: [] |
| 82 | +fail-config: |
| 83 | + description: the path to the failing test case config that refers to the orb jobs to be tested |
| 84 | + type: string |
| 85 | + default: "" |
| 86 | + |
| 87 | +test-steps: |
| 88 | + description: if you need more than 2 test cases, you can define your own test sequence here using the test command |
| 89 | + type: steps |
| 90 | + default: [] |
0 commit comments