You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update the CONTRIBUTING.md to use image-spec labels instead (#1710)
* Updating CONTRIBUTING.md to make the OpenContainers image-spec annotation keys optional.
Signed-off-by: Avi Miller <[email protected]>
Reviewed-by: Gerald Venzl <[email protected]>
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+26-7Lines changed: 26 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -32,20 +32,20 @@ signed the OCA can be accepted.
32
32
33
33
## Oracle Product Ownership and Responsibility
34
34
35
-
For any new product content, *you must obtain internal Oracle approvals for the
36
-
distribution of this content prior to submitting a pull request*. If you are
35
+
For any new product content, *you must obtain internal Oracle approvals for the
36
+
distribution of this content prior to submitting a pull request*. If you are
37
37
unfamiliar with the approval process to submit code to an existing GitHub
38
38
repository, please contact the [Oracle Open Source team](mailto:[email protected])
39
39
for details.
40
40
41
-
The GitHub user who submits the initial pull request to add a new product image
42
-
should add themselves to the [code owner](./CODEOWNERS) file in that same
43
-
request. This will flag the user as the owner of the content and any future pull
41
+
The GitHub user who submits the initial pull request to add a new product image
42
+
should add themselves to the [code owner](./CODEOWNERS) file in that same
43
+
request. This will flag the user as the owner of the content and any future pull
44
44
requests that affect the conten will need to be approved by this user.
45
45
46
46
The code owner will also be assigned to any issues relating to their content.
47
47
48
-
You must ensure that you check the [issues](https://github.com/oracle/docker-images/issues)
48
+
You must ensure that you check the [issues](https://github.com/oracle/docker-images/issues)
49
49
on at least a weekly basis, though daily is preferred.
50
50
51
51
If you wish to nominate additional or alternative users, they must be a visible
@@ -92,7 +92,10 @@ the image owner to implement it.
92
92
1. All images must provide a `CMD` or `ENTRYPOINT`. If your image is designed
93
93
to be extended, then this should output documentation on how to extend the
94
94
image to be useful.
95
-
1. Use `LABEL` instructions for additional information such as ports and volumes. The following are common label instructions that should be present in all images where applicable:
95
+
1. Use `LABEL` instructions for additional information such as ports and volumes.
96
+
The following are common label instructions that should be present in all images where applicable:
97
+
98
+
Additional product-specific labels are listed below:
96
99
97
100
| Label | Value | Applicability |
98
101
| -------- | ----- | ------------- |
@@ -117,6 +120,22 @@ LABEL "provider"="Oracle" \
117
120
"port.apex"="8080"
118
121
```
119
122
123
+
You may also chose to use the [OpenContainer `image-spec`](https://github.com/opencontainers/image-spec/blob/master/annotations.md#pre-defined-annotation-keys)
124
+
pre-defined annotation keys:
125
+
126
+
***org.opencontainers.image.created** date and time on which the image was built (string, date-time as defined by [RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)).
127
+
***org.opencontainers.image.authors** contact details of the people or organization responsible for the image (freeform string)
128
+
***org.opencontainers.image.url** URL to find more information on the image (string)
129
+
***org.opencontainers.image.documentation** URL to get documentation on the image (string)
130
+
***org.opencontainers.image.source** URL to get source code for building the image (should be the URL of this repository).
131
+
***org.opencontainers.image.version** version of the packaged software
132
+
***org.opencontainers.image.vendor** Name of the distributing entity, organization or individual (should be "Oracle").
133
+
***org.opencontainers.image.licenses** License(s) under which contained software is distributed as an [SPDX License Expression][spdx-license-expression].
134
+
***org.opencontainers.image.title** Human-readable title of the image (string)
135
+
***org.opencontainers.image.description** Human-readable description of the software packaged in the image (string)
136
+
137
+
The use of these keys is optional and at each image authors' discretion.
138
+
120
139
### Security-related Rules
121
140
122
141
1. Do not require the use of the `--privileged` flag when running a container.
0 commit comments