appsody stack package should honor .gitignore

appsody / appsody

Appsody command line tool. This repo will be archived soon.

https://appsody.dev

171 stars 46 forks source link

appsody stack package should honor .gitignore #459

Open kylegc opened 5 years ago

kylegc commented 5 years ago

Is your feature request related to a problem? Please describe. This is related to #444

Describe the solution you'd like Instead of hard coding directories and files to ignore, we should use some sort of configuration. .gitignore seems logical even if the stack developer isn't currently working from a git repository.

.gitignore can also be used to ignore files to be put into the stack and templates (see ci scripts, I think they do something similar).

Describe alternatives you've considered

hardcoding all files
using a different configuration file
ignoring all files and dirs that start with a .

neeraj-laad commented 5 years ago

@kylegc What do you have in mien when you say honour .gitignore?

adding files to stack docker images
adding files to template archives
identifying templates within the stack structure (<stack>/templates/)

This is how we do some of this today:

If stack creator's want to exclude things from stack docker images then they can add a .dockerignore file in their stack.
We add all files within a template directory to the template archive file (like .vscode and .gitignore), so users get these folders when they do an init.
Regarding identifying what should be treated as a template - could we simply iterate over folders (within the /templates/ dir) and not treat folders that start with a . as templates?

kylegc commented 5 years ago

Good questions. This was suggested by Erin as a follow-up to #444. In 444, the issue was .DS_Store on the mac was getting incorrectly picked up as a template in the <stack/templates/ dir. The idea is that we don't want to hard code individual files/dirs as they cause problems, we want a more configurable and standard way of ignoring files/dirs.

We could use this issue to design/define the larger appsody ignore strategy. For example, when is .dockerignore vs .gitignore appropriate and do these cover all appsody scenarios. There may be other scenarios, such as ignoring files to mount during appsody run/debug/test, which we don't cover today and may want to consider.