Publish to NPM

[kognise]

This PR contains changes necessary to smoothly publish Water.css to NPM. This closes #41! Does anything else need to be changed?

[diomed]

buttons wont be in this version?
please merge and release :P

[diomed]

#52

would really like to see this applied in current one

[kognise]

@diomed we'll work on getting those into the next release!

[diomed]

welp. I hoped to see it sooner, rather than later. I mean, you could put it off until tomorrow, and that are small changes really.

[kylejrp]

Hey sorry! I didn't realize I was marked as a reviewer on this.

I've never published to NPM before, so I'm not sure how to review this. As far as I can tell it's good, but I'm not sure what's all required to publish to NPM.

[kylejrp]

Hey @kognise, do you need any help with this? I'm not super familiar with NPM but I could learn some more about it to help get this published!

[jonaskuske]

What's the status here?

Would be happy to pick this up, update it to match the current master and look into Netlify Continuous Deployment so we'll get automatic releases to npm whenever something lands in master.

I imagine the setup (in GitHub) would look like this:

• branch dev: The development branch. PRs from contributors will be merged into this branch.

• branch master: The latest stable & published version. When we want to publish a new version, we merge the changes from dev into this branch, Netlify picks up the changes, runs gulp build, publishes a new version to npm and re-deploys the documentation site.

We could additionally publish the dev branch to npm under a different tag, e.g. water.css@dev or water.css@next. This way we'd have an automatic beta/canary version up on npm.

[jonaskuske]

Steps I see here:

• Get this branch up-to-date with master
• Add dist/ folder to .gitignore
• Set prepublishOnly script to yarn build so the package is automatically built whenever we publish
• Update Netlify config so it runs yarn publish on every production deploy

Additional and/or optional steps:

• Update Contributing guide
• Update Netlify config to run yarn publish --tag dev on every branch deploy from dev branch

Am I missing anything?

[kognise]

@jonaskuske that looks great! Sorry for being inactive recently.

I have early access to GitHub Actions, we could probably use that to setup CI/CD. I should be able to setup a pipeline that deploys master to NPM and publishes to Netlify.

Do you think it's a good idea to merge as many PRs as possible before doing this to avoid conflicts? This would be a pretty major change and we'd have to think about how to maintain backwards compatibility.

[kylejrp]

I'm excited to hear that you've got early access to GitHub actions - it'll be cool to see how it works!

I think that there were other breaking changes discussed in the CSS variables issue when we changed the path of the distributed css files. If we bump the semantic version to 2.0.0 at the same time we rename the main css files, we shouldn't have to worry about breaking backwards compatibility. More discussion here:
#71 (comment)

[kylejrp]

In summary, yes we should merge as much as we can and then do a 2.0.0 release.

[kylejrp]

I started the 2.0.0 milestone for all the issues that should be merged before publishing version 2.0.0 to NPM.

Once all issues there have been closed, we will be able to release on NPM! 🎉

[diomed]

so glad this is dragging along for whole year.
shows your true commitment to this project

[andrewsosa]

Does this PR need any help? This PR will have been open for almost a year next month.

[kognise]

Closing this because I updated the package.json in 1297b75 and we should probably continue the conversation in #187