fix: adjust the initial .gitignore for the latest changes #294
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the
.gitignore
file that is created by themyks init
command to reflect the latest changes in the.myks
directory.UPD: decided to just exclude the whole
.myks
directory by default.With these changes, the following files are ignored:
.myks/tmp
: data schema and values files managed bymyks
and refreshed on every run.myks/envs/**/helm
: helm values files generated bymyks
on every render of this app.myks/envs/**/steps
: yaml files with intermediate results of the rendering steps.myks/envs/**/argocd_defaults.ytt.yaml
: generated on every run default data values for the ArgoCD pluginWhat is not ignored by default (these files are useful for debugging and tracking upstream changes in PRs):
.myks/vendir-cache
: vendir cache entriesI personally keep it in git to track upstream changes, but now, for every update, there are a lot of renames that clutter PR diffs
Here is an example of such PR: https://github.com/Zebradil/myks-homelab/pull/130/files
.myks/envs/**/env-data.yaml
: generated data values files for environments, useful to see the final definition of an environment.myks/envs/**/vendor
: directory with links to the vendir cache entries.myks/envs/**/vendir-links.yaml
: map of vendor directories to cache entries.myks/envs/**/vendir.yaml
: generated vendir configuration file for this applicationIt feels like we can completely ignore the
.myks
directory by default and provide hints to users to include some of the ignored files and directories to satisfy particular use cases.