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

Document the need to set an explicit delimiter when using ModificationBehavior::{Append,Prepend} #700

Open
edmorley opened this issue Oct 19, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation libcnb

Comments

@edmorley
Copy link
Member

edmorley commented Oct 19, 2023

Currently the upstream CNB spec doesn't actually define what the default delimiter should be, when using the append/prepend functionality of CNB env vars:
https://github.com/buildpacks/spec/blob/main/buildpack.md#delimiter

In practice, the lifecycle implementation defaults to an empty string delimiter, which is not helpful in most cases.

Resolving this confusing default behaviour is the subject of:
buildpacks/spec#285

It also affected the examples in this repo:
#398

In the meantime we should document the current behaviour in libcnb.rs LayerEnv docs:
https://docs.rs/libcnb/latest/libcnb/layer_env/struct.LayerEnv.html
https://docs.rs/libcnb/latest/libcnb/layer_env/enum.ModificationBehavior.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation libcnb
Projects
None yet
Development

No branches or pull requests

1 participant