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 project root behavior in git repositories #66

Open
netthier opened this issue May 30, 2023 · 0 comments
Open

Document project root behavior in git repositories #66

netthier opened this issue May 30, 2023 · 0 comments

Comments

@netthier
Copy link

netthier commented May 30, 2023

Operating system

N/A

Browser

N/A

Bug description

The docs for deployment.yaml path-based includes currently contain the following text:

Only directories that are part of the kluctl project are allowed.

This is also the behavior that occurs in a simple kluctl project, i.e. path-based includes referencing directories anywhere else will not work (e.g. ../).
However, as per this thread in Slack this behavior changes when the project is inside of a git repository, in which case all paths inside the git repository are allowed.
This means that in a git repository containing two projects side-by-side one of them can include the other one with a ../other-project include.
This special behavior for includes inside git repositories should be documented.

Steps to reproduce

No response

Relevant log output

No response

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

No branches or pull requests

1 participant