Skip to content

Commit 19178f6

Browse files
authored
Merge pull request cds-hooks#393 from buildpacks/conventions-types
Fix source metadata types
2 parents 18b3400 + d778b5d commit 19178f6

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

content/docs/platform-guide/conventions/source-metadata.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,25 +17,25 @@ The following types are concrete source types and can use any keys as long as th
1717

1818
#### Git
1919

20-
- #### `type` _(string,required)_
20+
- #### `type` _(string, required)_
2121
Must be `git`
2222

2323
- #### `source` _(required)_
2424

2525
- `version` _(required)_
2626

27-
- `commit` _(string,required)_\
27+
- `commit` _(string, required)_\
2828
Full commit hash
2929

30-
- `describe` _(string,optional)_\
30+
- `describe` _(string, optional)_\
3131
Description of commit (see `git describe`)
3232

3333
- `metadata` _(optional)_
3434

35-
- `repository` _(string,optional)_\
35+
- `repository` _(string, optional)_\
3636
Repository URL
3737

38-
- `refs` _(string,optional)_\
38+
- `refs` _(list of strings, optional)_\
3939
Additional relevant Git references
4040

4141
###### Example
@@ -55,25 +55,25 @@ type = "git"
5555

5656
#### Image
5757

58-
- #### `type` _(string,required)_
58+
- #### `type` _(string, required)_
5959
Must be `image`
6060

6161
- #### `source` _(required)_
6262

6363
- `version` _(required)_
6464

65-
- `digest` _(string,required)_\
65+
- `digest` _(string, required)_\
6666
Image digest
6767

6868
- `metadata` _(optional)_
6969

70-
- `path` _(string,optional)_\
70+
- `path` _(string, optional)_\
7171
Absolute path to source in image
7272

73-
- `repository` _(string,optional)_\
73+
- `repository` _(string, optional)_\
7474
Fully-qualified image name
7575

76-
- `refs` _(string,optional)_\
76+
- `refs` _(list of strings, optional)_\
7777
Additional relevant image names/tags
7878

7979
###### Example
@@ -97,19 +97,19 @@ The following source information is considered additive and should not overlap w
9797

9898
#### `project.toml`
9999

100-
- #### `type` _(string,required)_
100+
- #### `type` _(string, required)_
101101
Must be `project` **(only if no other type is present)**
102102

103103
- #### `source` _(required)_
104104

105105
- `version` _(required)_
106106

107-
- `version` _(string,optional)_\
107+
- `version` _(string, optional)_\
108108
Version as declared in `_.version`
109109

110110
- `metadata` _(optional)_
111111

112-
- `url` _(string,optional)_\
112+
- `url` _(string, optional)_\
113113
URL as declared in `_.source-url`
114114

115115
###### Example (standalone)
@@ -143,4 +143,4 @@ type = "image"
143143
```
144144

145145
[lifecycle]: /docs/concepts/components/lifecycle/
146-
[project-metadata]: https://github.com/buildpacks/spec/blob/platform/0.7/platform.md#project-metadatatoml-toml
146+
[project-metadata]: https://github.com/buildpacks/spec/blob/platform/0.7/platform.md#project-metadatatoml-toml

0 commit comments

Comments
 (0)