Skip to content

Commit 2312ff6

Browse files
authored
feat: add docs for extraDevfileEntries.yaml (#445)
Signed-off-by: jingfu wang <[email protected]>
1 parent 39103b3 commit 2312ff6

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

docs/proposals/registry/registry-structure.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,36 @@ The following requirements are imposed on the devfile registry repository:
3636
2) Each devfile stack folder must contain a `devfile.yaml`. Other files such as vsx plugins, stack logos, etc. can be included as needed.
3737
3) Any build tools for the registry (such as scripts or Dockerfiles) should not be located at the top-level of the stack, and should reside in their own folder.
3838

39+
Optional file to support stacks/samples from other repositories:
40+
41+
A file called `extraDevfileEntries.yaml` can be added under the root of the devfile registry source repository to add samples and stacks from other repositories to the registry. This file contains the location information on where the extra samples and stacks can be found.
42+
43+
Sample `extraDevfileEntries.yaml`:
44+
```
45+
schemaVersion: 1.0.0
46+
samples:
47+
- name: nodejs-basic
48+
displayName: Basic NodeJS
49+
description: A simple Hello World application
50+
icon: nodejsIcon.svg
51+
tags: ["NodeJS", "Express"]
52+
projectType: nodejs
53+
language: nodejs
54+
git:
55+
remotes:
56+
origin: https://github.com/redhat-developer/devfile-sample
57+
- name: vertx-secured-http
58+
displayName: Vert.x with secured HTTP
59+
description: A Vert.x application using secured HTTP
60+
icon: vertxIcon.svg
61+
tags: ["Java", "Vert.x"]
62+
projectType: vertx
63+
language: java
64+
git:
65+
remotes:
66+
origin: https://github.com/openshift-vertx-examples/vertx-secured-http-example-redhat
67+
```
68+
3969
### Layer Media types
4070
Currently, when we push devfile stacks to an OCI registry, it's pushed as a single layer, using the `application/vnd.devfileio.devfile.layer.v2+yaml` media type. We should instead be pushing the stack as a multi-layer artifact, adding the additional layers:
4171

0 commit comments

Comments
 (0)