-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Default devfile name #12837
Comments
.devfileThe current "minimal" default name |
.devfile.ymlThat's similar to |
devfile.ymlWithout a dot because do we really need to "hide" the file? |
Devfile
|
I like the idea of making the file visible in the repo, and I quite like the analogy to Makefile. If we don't end up with a proliferation of similar files in the root, I would go with Devfile. or devfile.yml |
If it's a yaml file, I'd go with devfile.yml in order to benefit from syntax highlighting/colours/suggestions. If it's a Dockerfile-style file, then Devfile. |
Looks like devfile.yml - won This change will introduce breaking changes with existed ".devfile" factory flow. That means that if someone has a ".devfile" in the repository and use it with factory then default "empty" devfile would be used.
|
@skabashnyuk that looks like a good plan |
I noticed that YAML files in Che Plugin Registry have |
|
@l0rd Then it would be nice to use
|
Although But it doesn't really make a big difference to me. Should we start a new poll? I don't think so. Do what you think it's better but 1) be consistent 2) don't spend to much time discussing it ;-) |
I suggest we do it like OSBS does: support both |
Support both isn't a trivial task. That will require a huge refactoring of existing approach, which doesn't fit into this particular issue. You're welcome to create a new one where you can describe the motivation part. |
Description
The devfile is the new format that we use to define Che workspaces (c.f. http://redhat-developer.github.io/devfile).
We want users to include a devfile at the root of their github repository: they can then open a corresponding Che workspace just by opening the following URL:
https://<your-che-host>/f?url=<your-github-repo>
To support this use case we currently look for a specific file named
.devfile
at the root of the repository (<your-github-repo>/.devfile
).But
.devfile
may not be a good name because we don't get yaml syntax highlighting in most of the IDEs (Che included) (c.f. #12675). We could use.devfile.yml
but what aboutdevfile.yml
orDevfile
?What name do you prefer? Please add a 👍 to one of the comments below that correspond to your preferred naming.
The text was updated successfully, but these errors were encountered: