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

fix: adjust the initial .gitignore for the latest changes #294

Merged
merged 2 commits into from
May 19, 2024

Conversation

Zebradil
Copy link
Member

@Zebradil Zebradil commented May 19, 2024

This PR updates the .gitignore file that is created by the myks 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 by myks and refreshed on every run
  • .myks/envs/**/helm: helm values files generated by myks 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 plugin

What is not ignored by default (these files are useful for debugging and tracking upstream changes in PRs):

  • .myks/vendir-cache: vendir cache entries
  • .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 application

It 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.

@Zebradil Zebradil requested review from kbudde and fritzduchardt May 19, 2024 10:59
@Zebradil Zebradil self-assigned this May 19, 2024
@Zebradil Zebradil merged commit 2e1940f into main May 19, 2024
4 checks passed
@Zebradil Zebradil deleted the update-init-gitignore branch May 19, 2024 16:08
@fritzduchardt
Copy link
Collaborator

For my intents and purposes ignoring the entire .myks by default would be fine. It could contain a commented out line to stop ignoring vendir-cache

@Zebradil
Copy link
Member Author

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

Successfully merging this pull request may close these issues.

2 participants