Skip to content

starterProjects and projects description #42

@neeraj-laad

Description

@neeraj-laad

In a devfile that is being used to define a stack, there could be multiple starter projects, each providing a separate starter application (simple app, app integrated with Kafka, reactive app etc.)

Today we only have a name field to distinguish between them. But for developer to make a choice between these starter applications, having more details information on the capabilities you get with each project will be necessary.

If we can add starterProjects section, devfile creators will be able to use it for starter projects (only one should be selected by the user).

starterProjects:
  - name: "kafka-project"
    description: "Use this app to get a nodejs application for working with kafka"
  - name: "simple-project"
    description: "Use this app to get a simple "hello world" nodejs application"

starterProjects would have the same syntax as projects but a slightly different behavior: instead of cloning the git repo, only the source code would be fetched, the git metadata would not.

Moreover we would like to add the description field to both project and starterProject to help developers understand the content of the project.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/apiEnhancement or issue related to the api/devfile specification

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions