Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stacks/Devfile matching rules #40

Closed
elsony opened this issue Apr 21, 2020 · 4 comments
Closed

Stacks/Devfile matching rules #40

elsony opened this issue Apr 21, 2020 · 4 comments
Labels
area/api Enhancement or issue related to the api/devfile specification future Items in consideration to be added to future spec levels lifecycle/rotten Rotten items. These items have been stale for 60 days and are now closed. lifecycle/stale Stale items. These items have not been updated for 90 days.

Comments

@elsony
Copy link
Contributor

elsony commented Apr 21, 2020

In a devfile that is being used to define a stack, there are certain files that the stack may be looking for to decide if a given project can be run by a given stack or not, e.g. a maven stack may look for the pom.xml and a node.js stack may look for package.json.

If we can provide a way to allow a given stack to define those required resources, we can use it in tools like Che or odo to do quick check on project to suggest the stacks on a devfile repo that may support the a given application. An example can be:

parent.yaml
---
schemaVersion: 2.0.0
metadata:
  publisher: my-org
  name: maven-stack
  version: x.y.z
  matchingRules:
    existingFiles: ['pom.xml', 'aaa.xml']
devfile.yaml
---
schemaVersion: 2.0.0
metadata:
  name: my-maven-project
parent:
  id: organization/maven-stack/x.y.z
...

There may be other types other than existingFiles that we can support in the future.

@elsony elsony changed the title Validation info to validate the application that can be applicable to a given stack Discovery info to discover the application that can be applicable to a given stack/devfile Apr 21, 2020
@l0rd
Copy link
Contributor

l0rd commented Apr 28, 2020

Reviewed and agreed

@l0rd l0rd changed the title Discovery info to discover the application that can be applicable to a given stack/devfile Stacks/Devfile matching rules Apr 28, 2020
@davidfestal
Copy link
Collaborator

We will have to think about how we do the same for a parent existing as a Kubernetes resource (DevWorkspaceTemplate). We might want to use K8S metadata int his case, but then let's keep in mind that K8S metadata are simply a map of strings, while here the matching rules define a structured sub-schema. I assume we don't want to split the related syntax and have 2 different ways to express that between yaml parent devfiles and K8S CRD parents devfiles.

@davidfestal
Copy link
Collaborator

If that's a structured information that is valid for both the devfile Yaml and the devworkspace template CRD, I'd rather have a true field for it.

@l0rd l0rd added this to the 2.0.0 milestone Jun 24, 2020
@l0rd l0rd added the area/api Enhancement or issue related to the api/devfile specification label Jun 24, 2020
@l0rd l0rd mentioned this issue Jun 24, 2020
28 tasks
@kadel kadel modified the milestones: 2.0, 2.1 Jul 28, 2020
@elsony elsony removed this from the 2.2 milestone Mar 24, 2022
@elsony elsony added the future Items in consideration to be added to future spec levels label Mar 24, 2022
@Jdubrick Jdubrick moved this to Refinement in Devfile Project Mar 4, 2024
Copy link

This issue is stale because it has been open for 90 days with no activity. Remove stale label or comment or this will be closed in 60 days.

@github-actions github-actions bot added the lifecycle/stale Stale items. These items have not been updated for 90 days. label May 28, 2024
@github-actions github-actions bot added the lifecycle/rotten Rotten items. These items have been stale for 60 days and are now closed. label Jul 28, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Jul 28, 2024
@github-project-automation github-project-automation bot moved this from Refinement to Done ✅ in Devfile Project Jul 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/api Enhancement or issue related to the api/devfile specification future Items in consideration to be added to future spec levels lifecycle/rotten Rotten items. These items have been stale for 60 days and are now closed. lifecycle/stale Stale items. These items have not been updated for 90 days.
Projects
Status: Done ✅
Development

No branches or pull requests

4 participants