Skip to content

Commit

Permalink
fix: add some more docs (#127)
Browse files Browse the repository at this point in the history
  • Loading branch information
d2lam authored and tkyi committed Dec 4, 2017
1 parent fe2f5e3 commit d5904b3
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/user-guide/configuration/metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Screwdriver provides the shell command `meta get` to extract information from th

### Same pipeline

Screwdriver build can retrieve metadata set by itself or by the previous builds within the same pipeline.
Screwdriver build can retrieve metadata set by itself or by previous builds within the same pipeline.

Example: `build1` -> `build2` -> `build3`

Expand All @@ -48,12 +48,14 @@ $ meta get foo

### External pipeline

Screwdriver build can also access metadata set by an external job which triggers it.
Screwdriver build can also access metadata from an external triggering job by adding the `--external` flag followed by the triggering job.

Example: `sd@123:publish` -> `build1`. Then inside `build1`:
```
$ meta get example --external sd@123:publish
{"coverage":99.95}
```

Notes: `meta set` is not allowed for external builds.
Notes:
- `meta set` is not allowed for external builds.
- If the flag value is not the triggering job, then `meta get` will return `null`.

0 comments on commit d5904b3

Please sign in to comment.