Skip to content

Commit fa91027

Browse files
author
Kristian
authored
Merge pull request #130 from telia-oss/document-exploded-metadata
Add documentation for individual metadata files
2 parents 59ecc9b + 671e4a8 commit fa91027

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,10 @@ requested version and the metadata emitted by `get` are available to your tasks
7474
- `.git/resource/version.json`
7575
- `.git/resource/metadata.json`
7676

77+
The information in `metadata.json` is also available as individual files in the `.git/resource` directory, e.g. the `base_sha`
78+
is available as `.git/resource/base_sha`. For a complete list of available (individual) metadata files, please check the code
79+
[here](https://github.com/telia-oss/github-pr-resource/blob/master/in.go#L66).
80+
7781
When specifying `skip_download` the pull request volume mounted to subsequent tasks will be empty, which is a problem
7882
when you set e.g. the pending status before running the actual tests. The workaround for this is to use an alias for
7983
the `put` (see https://github.com/telia-oss/github-pr-resource/issues/32 for more details).

0 commit comments

Comments
 (0)