Skip to content

Commit b8e476d

Browse files
authored
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]>
1 parent cf62b31 commit b8e476d

File tree

1 file changed

+26
-7
lines changed

1 file changed

+26
-7
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,20 +32,20 @@ signed the OCA can be accepted.
3232

3333
## Oracle Product Ownership and Responsibility
3434

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
3737
unfamiliar with the approval process to submit code to an existing GitHub
3838
repository, please contact the [Oracle Open Source team](mailto:[email protected])
3939
for details.
4040

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
4444
requests that affect the conten will need to be approved by this user.
4545

4646
The code owner will also be assigned to any issues relating to their content.
4747

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)
4949
on at least a weekly basis, though daily is preferred.
5050

5151
If you wish to nominate additional or alternative users, they must be a visible
@@ -92,7 +92,10 @@ the image owner to implement it.
9292
1. All images must provide a `CMD` or `ENTRYPOINT`. If your image is designed
9393
to be extended, then this should output documentation on how to extend the
9494
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:
9699

97100
| Label | Value | Applicability |
98101
| -------- | ----- | ------------- |
@@ -117,6 +120,22 @@ LABEL "provider"="Oracle" \
117120
"port.apex"="8080"
118121
```
119122

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+
120139
### Security-related Rules
121140

122141
1. Do not require the use of the `--privileged` flag when running a container.

0 commit comments

Comments
 (0)