Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Default devfile name

See original GitHub issue

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 about devfile.yml or Devfile?

What name do you prefer? Please add a 👍 to one of the comments below that correspond to your preferred naming.

Issue Analytics

State:
Created 5 years ago
Comments:15 (15 by maintainers)

Top GitHub Comments

12reactions

l0rdcommented, Mar 6, 2019

devfile.yml

Without a dot because do we really need to “hide” the file?

5reactions

l0rdcommented, Mar 6, 2019

.devfile.yml

That’s similar to .travis.yml and allow to have yaml syntax highlighting.

Top Results From Across the Web

Introduction to Devfile - GitHub Pages

Name. Without any further configuration a workspace with default editor will be launched along with its default plugins which are configured on Che...

Chapter 4. Authoring devfiles - Red Hat Customer Portal

The default value is the project name. Example devfile with projects.

Configuring your Dev Environment - Amazon CodeCatalyst

If you change the devfile or devfile component name, the contents of the /home ... a default universal devfile will be applied to...

Using customized devfile to create a workspace - IBM

In addition to the default devfiles, Wazi Developer for Workspaces allows users ... loaded by default projects: - name: ibm-zopeneditor-sample source: type: ...

Adding commands - Devfile

Define attributes for the exec command to run using the default shell in the container. ... schemaVersion: 2.1.0 metadata: name: mydevfile projects: -...