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

feat: Adding stack with minimal Devfile that only contains metadata fields and the schema version #118

Closed
wants to merge 1 commit into from

Conversation

ibuziuk
Copy link
Collaborator

@ibuziuk ibuziuk commented Aug 2, 2022

Signed-off-by: Ilya Buziuk ibuziuk@redhat.com

What does this PR do?:

Adding stack with minimal Devfile that only contains metadata fields and the schema version.
For Eclipse Che / Dev Spaces that devfile can be used for starting a workspace without any projects cloned.

Which issue(s) this PR fixes:

Related to eclipse-che/che#21554

PR acceptance criteria:

  • Contributing guide
    Have you read the devfile registry contributing guide and followed its instructions?
  • Test automation
    Does this repository's tests pass with your changes?
  • Documentation
    Does any documentation need to be updated with your changes?
  • Check Tools Provider
    Have you tested the changes with existing tools, i.e. Odo, Che, Console? (See devfile registry contributing guide on how to test changes)

How to test changes / Special notes to the reviewer:

The build is currently failing with Error: failed to generate index struct: /build/stacks/empty devfile is not valid: [metadata.language is not set metadata.projectType is not set] but the question is do we really want to enforce the language and the projectType ?

…ields and the schema version

Signed-off-by: Ilya Buziuk <ibuziuk@redhat.com>
@openshift-ci
Copy link

openshift-ci bot commented Aug 2, 2022

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: ibuziuk
Once this PR has been reviewed and has the lgtm label, please assign elsony for approval by writing /assign @elsony in a comment. For more information see:The Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kadel
Copy link
Member

kadel commented Aug 5, 2022

Would this stack be ever useful for someone?
This looks like a "hack" just for Che :-/

@ibuziuk
Copy link
Collaborator Author

ibuziuk commented Aug 30, 2022

Would this stack be ever useful for someone?
This looks like a "hack" just for Che :-/

This is not meant to be a hack by any means, but rather the most minimal devfile anyone could start with. The analogy could be docker scratch - https://hub.docker.com/_/scratch
In general, we are constantly getting feedback that defiles are complex and hard to start with. The idea is to provide the minimalistic empty / scratch devfile that anyone could start with without overhead @slemeur @l0rd wdyt?

@@ -0,0 +1,7 @@
schemaVersion: 2.2.0
metadata:
name: empty
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

might be better to name it as scratch to use the common analogy in the container world with https://hub.docker.com/_/scratch

@kadel
Copy link
Member

kadel commented Sep 1, 2022

This is not meant to be a hack by any means, but rather the most minimal devfile anyone could start with. The analogy could be docker scratch - https://hub.docker.com/_/scratch

This is a good analogy. Similar to a scratch container, this just on its own is not useful for anything. But it is a good starting point for building on top of it. That is why I don't think that this should be in a devfile registry together with other devfile stacks.
Something like this should be mentioned in the documentation together with description how to bould your own devfile stack.

In general, we are constantly getting feedback that defiles are complex and hard to start with. The idea is to provide the minimalistic empty / scratch devfile that anyone could start with without overhead @slemeur @l0rd wdyt?

Devfile is, by its own definition, complex and hard to start with, and I'm afraid that in its current form, it always will be. Devfile is just a big complex structure.

The approach to address this should be that we try to create a good set of devfile stacks that can be used out-of-the box for most of the projects. The only time user would need to touch devfile.yaml directly is if the users' project has something non-standard, unique, or specific to only their project.

@christoph-jerolimov
Copy link
Member

/uncc

@openshift-ci openshift-ci bot removed the request for review from christoph-jerolimov September 28, 2022 22:43
Copy link

openshift-ci bot commented May 23, 2024

@ibuziuk: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/v4.7-images 7f15715 link true /test v4.7-images
ci/prow/v4.7-registry-test 7f15715 link true /test v4.7-registry-test
ci/prow/v4.11-images 7f15715 link true /test v4.11-images
ci/prow/v4.11-registry-test 7f15715 link true /test v4.11-registry-test
ci/prow/v4.12-images 7f15715 link true /test v4.12-images
ci/prow/v4.12-registry-test 7f15715 link true /test v4.12-registry-test
ci/prow/v4.13-images 7f15715 link true /test v4.13-images
ci/prow/v4.13-registry-test 7f15715 link true /test v4.13-registry-test
ci/prow/v4.14-registry-test 7f15715 link true /test v4.14-registry-test
ci/prow/v4.14-images 7f15715 link true /test v4.14-images

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@michael-valdron
Copy link
Member

This PR has been open for almost 2 years now and will close for now, feel free to re-open if you'd like to resume effort on this contribution.

cc @devfile/devfile-services-team @ibuziuk

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants