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

Message "Devfile version 1 found" is shown although project has no Devfile #21957

Closed
nickboldt opened this issue Jan 26, 2023 · 6 comments
Closed
Assignees
Labels
area/factory/dashboard Issues related to factories frontend (che user dashboard side) kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P1 Has a major impact to usage or development of the system. sprint/current team/A This team is responsible for the Che Operator and all its operands as well as chectl and Hosted Che

Comments

@nickboldt
Copy link
Contributor

nickboldt commented Jan 26, 2023

Is your task related to a problem? Please describe

There's a message reported when a project is loaded with no devfile, which states that:

  • Devfile could not be found
  • Applying the default config
  • Devfile version 1 found, converting it to devfile version 2.1.0.

image

Describe the solution you'd like

If v2.1 is the curent default, then why are we using a v1 default for workspaces without a devfile, then converting it to 2.1?

Surely we should use a v2.1 devfile from the start and avoid the dependency on the devfile converter API?

Describe alternatives you've considered

If in fact this is just a bad status message, we could simply remove the note about conversion.

But it's worth making sure we use a default devfile that's already v2.1

Additional context

screenshot is from dev sandbox, Dev Spaces 3.3.0: https://devspaces.apps.sandbox.x8i5.p1.openshiftapps.com/dashboard/#/load-factory?url=https%3A%2F%2Fgithub.com%2Fnickboldt%2Fwin10-bluetooth-headphones%2F

Error icon is because I already had this same project open, so ignore that.

@nickboldt nickboldt added the kind/task Internal things, technical debt, and to-do tasks to be performed. label Jan 26, 2023
@che-bot che-bot added the status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. label Jan 26, 2023
@nickboldt nickboldt changed the title Improve error message when Improve messaging when loading a project w/ no devfile Jan 26, 2023
@nickboldt nickboldt added severity/P2 Has a minor but important impact to the usage or development of the system. area/factory/dashboard Issues related to factories frontend (che user dashboard side) labels Jan 26, 2023
@nickboldt nickboldt changed the title Improve messaging when loading a project w/ no devfile default devfile should be v2.1 / improve messaging when loading a project w/ no devfile Jan 26, 2023
@l0rd l0rd changed the title default devfile should be v2.1 / improve messaging when loading a project w/ no devfile Message "Devfile version 1 found" is shown on projects without a Devfile Jan 27, 2023
@l0rd l0rd changed the title Message "Devfile version 1 found" is shown on projects without a Devfile Message "Devfile version 1 found" is shown although project has no Devfile Jan 27, 2023
@l0rd l0rd added severity/P1 Has a major impact to usage or development of the system. and removed severity/P2 Has a minor but important impact to the usage or development of the system. status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. labels Jan 27, 2023
@l0rd
Copy link
Contributor

l0rd commented Jan 27, 2023

Thanks for opening this @nickboldt. I am raising the sev to P1 as this misleading message is shown systematically to new users that are trying Che on their git repository (where they didn't had the chance to include a devfile, yet).

And considered that we support v2.2 of the devfile spec we should say "converting to devfile version 2" (although here there is nothing to convert so the converting message doesn't make any sense).

@ibuziuk ibuziuk added sprint/next team/A This team is responsible for the Che Operator and all its operands as well as chectl and Hosted Che labels Jan 30, 2023
@ibuziuk
Copy link
Member

ibuziuk commented Jan 30, 2023

@olexii4 @akurinnoy folks, just a heads-up we would need to take this issue in the next sprint and backport to 7.60.x

@nickboldt
Copy link
Contributor Author

Seems like a simple thing to fix...

eclipse-che/che-dashboard#714

@ibuziuk
Copy link
Member

ibuziuk commented Jan 30, 2023

@nickboldt not really following how exactly eclipse-che/che-dashboard#714 can help with the "Devfile version 1 found "is shown although the project has no Devfile` 🤷

PR contains just cosmetic wording changes and does not seem to handle the case when the project does not contain a devfile.

@nickboldt
Copy link
Contributor Author

nickboldt commented Feb 1, 2023

I moved the second half of the comment up inside the if block so that it won't echo unless a conversion is actually happening, for a found devfile. If no devfile is found, then the message should just say "using the default" and not "which we also converted from v1 to v2 for some reason" :D

But if you have a better solution, happy to review your PR. Was just looking for a simple fix to a confusing error message.

@nickboldt
Copy link
Contributor Author

Fixed in current dev sandbox w/ 3.5:

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/factory/dashboard Issues related to factories frontend (che user dashboard side) kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P1 Has a major impact to usage or development of the system. sprint/current team/A This team is responsible for the Che Operator and all its operands as well as chectl and Hosted Che
Projects
None yet
Development

No branches or pull requests

5 participants