search

apache / cordova

Apache Cordova
https://cordova.apache.org/
615 stars 64 forks source link

[npm] Clean up package content #113

Open janpio opened 5 years ago

janpio commented 5 years ago

Currently npm packages contains folders like .github, and files like .appveyor.yml and .travis.yml. Those are probbably not useful in a package context, so should be excluded (if possible).

Implementation Progress

Platforms

Plugins

Tooling

Excluded: cordova-status, cordova, and any unused, outdated, or deprecated repos

erisu commented 5 years ago

It is possible.

See the cordova-electron repo for example: https://github.com/apache/cordova-electron/blob/master/.npmignore

Things I believe should also be excluded from the package:

janpio commented 5 years ago

Great.

One thing to note: The "vote" procedure usually contains steps to make sure a package actually works, which until now meant running the tests (for plugins for example via the included tests-plugin, and generally via npm test). This might conflict with the removal from the package.

erisu commented 5 years ago

Yeah, that might have to change.

I feel they should be excluded because it also has no value to an end user who is only trying to develop their own app. If they want to test our code, at that point they should be using GitHub as a developer for the Cordova product.

IMO, if I am releasing something, I had already ran the tests before I made the package as well as validating the CI services were green which ran the same tests. I feel that the releasers own +1 vote should also mean that they tested since these steps are written in the release guide.

Anyways, this might need to be a later discussion in another ticket or email thread.

raphinesse commented 4 years ago

@erisu I know you did some work on this. Unfortunately the PRs/commits didn't reference this issue. I guess this is not yet done in all repos. How do we want to handle this issue. Add a todo list?

erisu commented 4 years ago

I think we can add a todo list in this ticket and check off the ones that are completed.

brodycj commented 4 years ago

I would also consider just adding the files field to package.json in each package to specify exactly which artifacts we do need to publish on npm.

timbru31 commented 4 years ago

List updated as of June 2020. We are missing some platform and toolings, I've done all plugins over the past few months.