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

options to avoid .upignore to pickup .gitignore by default? #557

Closed
zhenyulin opened this Issue Jan 23, 2018 · 4 comments

Comments

Projects
None yet
3 participants
@zhenyulin
Copy link

zhenyulin commented Jan 23, 2018

Prerequisites

  • I am running the latest version. (up upgrade)
  • I searched to see if the issue already exists.
  • I inspected the verbose debug output with the -v, --verbose flag.
  • Are you an Up Pro subscriber?

Description

Just started to use up and was amazed by its simplicity. Wasn't aware that .upignore would pick up .gitignore by default until checked the examples after wondering why the built file isn't upload to Lambda.

Was thinking if it is more intuitive to have .upignore independent from .gitignore so that it wouldn't require the pre-knowledge that it would extend it by default.

Furthermore, it helps to make it more explicit and doesn't need to check two files when it comes confirming the settings.

further thought

can be very useful to have the feature as a separate module to make it possible to add @extend .gitignore, can potentially be very useful to help manage .dockerignore, eslintignore as well

@tj

This comment has been minimized.

Copy link
Member

tj commented Jan 23, 2018

I'd totally agree from a UX perspective that it can be confusing, my main concern is included sensitive files by accident which would normally be gitignored.

Definitely open to suggestions there, maybe it would be possible to make missing files a bit easier to troubleshoot, right now there's just up -v and up build --size which lists the contents.

@tj tj added the UX label Jan 23, 2018

@zhenyulin

This comment has been minimized.

Copy link
Author

zhenyulin commented Jan 23, 2018

was thinking of possibly using "index" field in the config file so that it could be checked before deploy? currently for Node it seems the run command would rely on "start" command in the package.json. This might help to make this independent from package.json.

@tamagokun

This comment has been minimized.

Copy link

tamagokun commented Feb 1, 2018

I tend to agree with this. What you explicitly store in the repo isn't necessarily what you are trying to package for a deployment to Lambda. I'd say that a lot of projects beyond simple examples will have some kind of build step, which would result in output that would most likely be in .gitignore therefore also needing to get added to .upignore as negated (!./build).

I don't know how many times i've bashed my head on the keyboard because my deployment didn't work and then, aha! .upignore!

I see a few options here:

  1. Keep the .upignore route, ignore dotfiles by default, and any language specific defaults (i.e. node_modules).

  2. Use a "files" convention similar to that of package.json to whitelist what files should be included in the deployment. If files isn't provided, it uses everything. (maybe ignore dotfiles by default here too)

@tj

This comment has been minimized.

Copy link
Member

tj commented Feb 1, 2018

Yeah I think those are valid points, sensitive stuff tends to be in dotfiles, I can't really think of any others off-hand.

  • remove .gitignore sourcing
  • adjust docs
  • adjust examples

@tj tj closed this in 017c53f Feb 3, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.