Skip to content
This repository was archived by the owner on Dec 1, 2024. It is now read-only.

Commit 15536f9

Browse files
authored
Add publish instructions and download-prebuilds npm script (#564)
1 parent 19118ce commit 15536f9

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -363,6 +363,17 @@ Alternatively, you can initialize submodules inside the cloned folder:
363363
$ git submodule update --init --recursive
364364
```
365365

366+
### Publishing
367+
368+
1. Increment the version: `npm version ..`
369+
2. Push to GitHub: `git push --follow-tags`
370+
3. Wait for Travis and AppVeyor builds to complete
371+
4. Download prebuilds into `./prebuilds`: `npm run download-prebuilds`
372+
5. Optionally verify loading a prebuild: `rimraf build && npm t`
373+
6. Optionally verify which files npm will include: `irish-pub`
374+
7. Add changelog to the GitHub release
375+
8. Finally: `npm publish`
376+
366377
### Windows
367378

368379
A large portion of the Windows support comes from code by [Krzysztof Kowalczyk](http://blog.kowalczyk.info/) [@kjk](https://twitter.com/kjk), see his Windows LevelDB port [here](http://code.google.com/r/kkowalczyk-leveldb/). If you're using `leveldown` on Windows, you should give him your thanks!

package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
"nyc": "^12.0.2",
3232
"optimist": "~0.6.1",
3333
"prebuildify": "^2.9.1",
34+
"prebuildify-ci": "^1.0.4",
3435
"readfiletree": "~0.0.1",
3536
"remark-cli": "^5.0.0",
3637
"remark-github": "^7.0.3",
@@ -47,6 +48,7 @@
4748
"coverage": "nyc report --reporter=text-lcov | coveralls",
4849
"rebuild": "node-gyp rebuild",
4950
"prebuild": "prebuildify --napi --strip",
51+
"download-prebuilds": "prebuildify-ci download",
5052
"changelog": "remark CHANGELOG.md -o"
5153
},
5254
"remarkConfig": {

0 commit comments

Comments
 (0)