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

Remove generated file from VCS #3033

Closed
wants to merge 3 commits into from
Closed

Conversation

ScottFreeCode
Copy link
Contributor

Resolves #2615

@ScottFreeCode ScottFreeCode added semver-major implementation requires increase of "major" version number; "breaking changes" area: repository tooling concerning ease of contribution labels Sep 29, 2017
@coveralls
Copy link

Coverage Status

Coverage remained the same at 89.12% when pulling 25dd654 on no-generated-file into f01f66e on master.

@ScottFreeCode
Copy link
Contributor Author

Do we have any mentions of Bower support we would need to edit away for this too?

@boneskull
Copy link
Contributor

Yes, so, bower.json needs to be removed, and we will need to update any relevant documentation.

I'm not sure if we need to do anything with Bower itself, like deprecate the package or whatever. Please open an issue here or hit someone up in Discord chat...

Copy link
Contributor

@boneskull boneskull left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • remove bower.json
  • contact Bower team if necessary
  • we may need to change how we're using the browser field of package.json and just do that stuff on the command-line, then point browser to mocha.js. this may impact users who are bundling Mocha themselves, but maybe not.
  • ensure mocha.js is in files field of package.json
  • (we cannot move mocha.js because modules like karma-mocha have hardcoded this path)

@boneskull
Copy link
Contributor

This will also likely break mocha init.

@ScottFreeCode
Copy link
Contributor Author

This will also likely break mocha init .

Only for usage from git, right? From NPM mocha init should just keep using the published file?

•we may need to change how we're using the browser field of package.json and just do that stuff on the command-line, then point browser to mocha.js . this may impact users who are bundling Mocha themselves, but maybe not.

I'm not clear why our workflow in this regard would be affected; this may be a good change to make but if we're still publishing the same stuff it shouldn't be necessitated by the removal of the built file from version control.

•contact Bower team if necessary

There's an unregister command, but I don't know if we want to unregister it given that versions < 4 should continue to work... Asking around and will update here when I have anything to show for it.

•remove bower.json
•ensure mocha.js is in files field of package.json

Will update these now...

@ScottFreeCode
Copy link
Contributor Author

mocha.js is already in package.json's files; bower.json used to be in it, removed that. Also removed bower.json

@ScottFreeCode
Copy link
Contributor Author

According to bower/bower#2482, I believe the idea is to make a copy of this repo containing only the old versions, then point Bower to that instead of this repo, then leave that repo as-is unless and until we have a need to change anything on Bower.

@boneskull Do you have the Bower permissions needed to do that?

@boneskull
Copy link
Contributor

no, I didn't register it initially. you'll just have to ask them to change it--please let me know if you need assistance

@boneskull
Copy link
Contributor

Only for usage from git, right? From NPM mocha init should just keep using the published file?

Yeah, you're right, n/m

From what I understand from that issue, basically all we need to do is remove bower.json when we tag v4.0.0. This will break users who have depended on mocha: "*", but really, that's not our problem.

@boneskull
Copy link
Contributor

so, I think I'm gonna close this. I don't think we need to muck with browser for now, since it won't affect our builds.

@boneskull boneskull closed this Oct 1, 2017
@ScottFreeCode ScottFreeCode deleted the no-generated-file branch November 25, 2017 03:47
@boneskull boneskull removed their assignment Dec 12, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: repository tooling concerning ease of contribution semver-major implementation requires increase of "major" version number; "breaking changes"
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants