Commit graph

9 commits

Author SHA1 Message Date
Brad Buchanan
93055f4b4a Prepare for npm publishing
Introduces some small package changes that simplify publishing Piskel to NPM as a ready-to-use application.

Since Piskel is not simply a JavaScript "module" (not something one would 'require' into another application) its role as a package on npm is somewhat unconventional - it contains the release build of Piskel, ready to serve as a static website, and a small `piskel-root` utility that will print the absolute path to that content (which will have been installed who-knows-where by npm).

Mostly this works by adding the "files" and "bin" entries to package.json, and by adding an .npmignore file (which simply prevents npm from using your .gitignore and ignoring the built files that we want to ship).

With these settings in place you could publish to npm anytime (as long as you have permission) but I've added `preversion` and `postversion` scripts to simplify and automate the process.  Here's how you publish a release:

```
npm login # If not already logged in
npm version [major|minor|patch|<other>] # see `npm help version` for more options
```

By itself this will lint, run the full test suite, do a release build, make sure the working directory is clean, bump the version number in package.json, commit the version number change and add a git tag with the new version, push the new version to GitHub and publish the release build output to npm.

If you don't have an npm account, create one at npmjs.com.  You'll need to do the initial release.

An npm user should then be able to download the latest Piskel release by running `npm install piskel`.  They could then find the location of Piskel's index.html by running `` `npm bin`/piskel-root `` (perhaps more useful for automation purposes... our own build copies the built Piskel release from its npm-installed location to a directory where it gets served by Rails).

By itself this may not seem _that_ useful, but it's a step toward making Piskel easier to embed with other appilications.  I've got a start on the next big improvement, where a parent application can `require('piskel')` to get an API object that facilitates communication with the editor running within an iframe.  You can see an early version of that at https://github.com/code-dot-org/piskel/pull/7
2016-06-17 17:07:03 -07:00
jdescottes
3d1a24d5cf Issue #344 : cleanup dest folder(s), cleanup Gruntfile 2015-12-01 00:41:02 +01:00
jdescottes
ac9ccd04e2 Fix currentcolors on sprites with many frames 2015-04-29 04:00:46 +02:00
jdescottes
d31865a9ef Update windows build scripts after nw version update 2015-04-26 22:46:40 +02:00
juliandescottes
96ef362cf8 preparing release v0.3.0 2014-09-28 11:20:34 +02:00
jdescottes
b0ec276aac Adding karma tests to grunt build 2014-08-14 01:50:33 +02:00
jdescottes
8f5ead43d9 Fix : remove cache issues for css, js, templates
Packaged css and js are now suffixed with the build date.
All templates are exported to a folder named after the build date.
Streamlined the build process to copy files to piskel-website.

Isolated common part between piskel and piskel-website in a separated
template, which is now completely created by the grunt build of piskel.

Added a windows CMD script to copy the static resources to piskel-website.
2014-07-06 16:17:14 +02:00
jdescottes
5e5ec1a358 Scripts for packaging application 2014-06-22 00:05:02 +02:00
jdescottes
42c799d217 added scripts for desktop packaging 2014-06-21 22:39:37 +02:00