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

generated gitignore is too strict #134

Closed
duncdrum opened this issue Aug 6, 2021 · 4 comments · Fixed by #136
Closed

generated gitignore is too strict #134

duncdrum opened this issue Aug 6, 2021 · 4 comments · Fixed by #136
Assignees
Labels
extensibility issues that hinder extensibility good first issue issues good for newcomers and beginners help wanted issues which are free to be picked up

Comments

@duncdrum
Copy link
Contributor

duncdrum commented Aug 6, 2021

Bug Description:

When using this template the generated .gitignore contains

webpack.config.js

since the file is for user modifications, in combination with gen-webpack.config.js it makes no sense to have it ignored (while still being checked into the git tree) OOTB.

While it is easy for users to manualy unignore the file, it should be a simple fix to remove it from the .gitignore here and save everyone the hassle.

Steps to Reproduce:

  1. Follow usage guide in readme
  2. Check applied gitignore when moving generated files into a git repo

Additional Information

  • Operating System: all
  • Theia Version: all

see theia-ide/yangster-electron#33

@marcdumais-work marcdumais-work added the proposal potential feature requests or proposals label Aug 6, 2021
@marcdumais-work
Copy link
Contributor

Hi @duncdrum

it makes no sense to have it ignored (while still being checked into the git tree) OOTB.

Currently, it seems that webpack.config.js is both ignored and not part of the git source tree. If we proceed with this change, I guess it would make sense to also check it in, correct? And I think also to commit any future changes, like we usually do for yarn.lock?

The following SO question/accepted answer seems to confirm that this config file should generally be checked-in:

https://stackoverflow.com/questions/55166226/webpack-does-webpack-config-js-get-commited

cc: @paul-marechal WDYT?

@marcdumais-work marcdumais-work added good first issue issues good for newcomers and beginners help wanted issues which are free to be picked up labels Aug 6, 2021
@vince-fugnitto
Copy link
Member

I believe webpack.config.js should not be gitignored and included in the repository, the generated gen-webpack.config.js should be ignored however. It also follows the examples we have in the main repository:

@marcdumais-work marcdumais-work added the extensibility issues that hinder extensibility label Aug 6, 2021
@marcdumais-work
Copy link
Contributor

@duncdrum would you submit a PR to fix this?

@marcdumais-work marcdumais-work removed the proposal potential feature requests or proposals label Aug 6, 2021
@duncdrum
Copy link
Contributor Author

duncdrum commented Aug 6, 2021

Will do

duncdrum added a commit to evolvedbinary/theia-blueprint that referenced this issue Aug 9, 2021
@duncdrum duncdrum mentioned this issue Aug 9, 2021
1 task
marcdumais-work pushed a commit that referenced this issue Aug 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
extensibility issues that hinder extensibility good first issue issues good for newcomers and beginners help wanted issues which are free to be picked up
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants