devfile special envs cannot be defined last in the env list

[maysunfaisal]

/kind bug

Which area is this bug related to?

/area library
/area registry

Bug Summary

Describe the bug:

Devfile has special Envs like PROJECTS_ROOT. These special Envs can be referenced by the container Envs.. Since they are dependent Envs, PROJECTS_ROOT cannot be defined in the end of the container Envs.

Check https://kubernetes.io/docs/tasks/inject-data-application/define-interdependent-environment-variables/ for reference

• Update ENV list for all special/reserved ENVs in devfiles as per the above note, seems to here
• Ensure that the bug is not due to bad references in devfiles that might contribute to ENV not being expanded

To Reproduce:

Expected behavior

Envs referencing PROJECTS_ROOT and similar other special Envs should be expanded without issues

Any logs, error output, screenshots etc? Provide the devfile that sees this bug, if applicable

Slack conversation on #forum-devfile 06/13

Additional context

Any workaround?

Suggestion on how to fix the bug

[Horiodino]

hey @maysunfaisal if anyone's not working on it i would like to work on this issue

[AObuchow]

FWIW, we encountered this in DevWorkspace Operator: devfile/devworkspace-operator#1282

[maysunfaisal]

@Horiodino sure, please feel free to assign yourself the issue and mark it as in progress, thank you!

[Horiodino]

i think this is already in progress https://github.com/devfile/devworkspace-operator/pull/1282

[maysunfaisal]

@Horiodino devfile/devworkspace-operator#1282 is fixing the repo https://github.com/devfile/devworkspace-operator.

I think this issue could be used to fix https://github.com/devfile/library/blob/main/pkg/devfile/generator/utils.go#L156-L160.

The devworkspace-operator team does not use this repo https://github.com/devfile/api/issues for their issue tracking.