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

Cleanup references to Che in devfile stack authors guide #76

Closed
metacosm opened this issue Jun 8, 2020 · 5 comments
Closed

Cleanup references to Che in devfile stack authors guide #76

metacosm opened this issue Jun 8, 2020 · 5 comments
Labels
area/api Enhancement or issue related to the api/devfile specification area/documentation Improvements or additions to documentation kind/bug Something isn't working severity/blocker Issues that prevent developers from working
Milestone

Comments

@metacosm
Copy link
Contributor

metacosm commented Jun 8, 2020

Environment variables that are injected by default are all prefixed by the CHE_ prefix and several (most?) of them don't make sense outside of a Che context. Default environment variables should be audited and renamed to something more Che-independent.

@metacosm
Copy link
Contributor Author

metacosm commented Jun 8, 2020

See in particular #17 (comment) for an example.

@l0rd
Copy link
Contributor

l0rd commented Jun 8, 2020

Sure @metacosm but there is no mention of the CHE_ env variables in the spec. The example in the issue that you have linked is about the v1.

@l0rd l0rd added the kind/question Further information is requested label Jun 8, 2020
@metacosm
Copy link
Contributor Author

metacosm commented Jun 8, 2020

Sure but the guide to stack authors, which unless I'm mistaken, targets devfile 2.0 is clearly riddled with Che-related references and environment variables: https://devfile.github.io/website/devfile/assembly_making-a-workspace-portable-using-a-devfile.html#_mounting_project_sources or https://devfile.github.io/website/devfile/assembly_making-a-workspace-portable-using-a-devfile.html#_environment_variables. Also, the spec surely cannot be reduced to a schema as it's also supposed to define behavior (such as presence of default environment variables).

@l0rd
Copy link
Contributor

l0rd commented Jun 8, 2020

@metacosm ok now I get it. Thanks for reporting this. cc @elsony

@l0rd l0rd added area/documentation Improvements or additions to documentation kind/bug Something isn't working and removed kind/question Further information is requested labels Jun 8, 2020
@l0rd l0rd changed the title Rename (and clean up?) default environment variables Cleanup references to Che in devfile stack authors guide Jun 8, 2020
@l0rd l0rd added the severity/blocker Issues that prevent developers from working label Jun 11, 2020
@l0rd l0rd added this to the 2.0.0 milestone Jun 11, 2020
@l0rd l0rd added the area/api Enhancement or issue related to the api/devfile specification label Jun 24, 2020
@kadel kadel modified the milestones: 2.0, 2.1 Jul 28, 2020
@jc-berger
Copy link

Closing as the PR addressing these concerns have been merged.

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 area/documentation Improvements or additions to documentation kind/bug Something isn't working severity/blocker Issues that prevent developers from working
Projects
None yet
Development

No branches or pull requests

4 participants