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

Consider which deployment files should be ignored within git #6

Closed
ctgraham opened this issue Jul 22, 2021 · 4 comments
Closed

Consider which deployment files should be ignored within git #6

ctgraham opened this issue Jul 22, 2021 · 4 comments

Comments

@ctgraham
Copy link
Member

Almost certainly files under dist/ and node_modules/ should be included in the a .gitignore so that the git repository is only tracking local source code changes. The dependencies and the packaged application should only exist in deployed packages (releases), or left to the administrator to deploy when the application is installed.

To capture the state of the the application when it has been tested with specific dependencies, you will want to include the package-lock.json file in the git repository. If specific dependency versions are non-critical, you may want to exclude the package-lock.json file via the .gitignore.

For configuration files where the administrator who is deploying the application has choices to make (such as database names, passwords, backend hostnames, ports, etc.), the git repo should provide sample files or sample values, with instructions to the administrator for changes. For example, consider src/environments/environment.prod.ts.

@Xiaoxin-He
Copy link
Collaborator

Xiaoxin-He commented Jul 26, 2021

  • gitignore is updated with including dist/ folder, so will not be included with the source code.
  • I would like to keep package-lock.json since I could keep track of versions changes or updates during implementation.
  • since the API root of src/environments/environment.prod.ts is the same as which backend service is running on and pointing to the server, so we just need the API ROOT key for the environment on the front-end, (comment is included)

@ctgraham
Copy link
Member Author

I think this issue is almost resolved, but we still need to remove the node_modules directory itself from the repo.

@Xiaoxin-He
Copy link
Collaborator

node_modules is updated in git ignore

@ctgraham
Copy link
Member Author

ctgraham commented Aug 9, 2021

Confirmed.

@ctgraham ctgraham closed this as completed Aug 9, 2021
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

2 participants