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.

Sign up for GitHub

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

Jump to bottom

Add publish instructions and download-prebuilds npm script #564

Merged
merged 2 commits into from
Dec 16, 2018
Merged

Add publish instructions and download-prebuilds npm script #564

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1aa69d
add publish instructions and download-prebuilds npm script
vweevers Dec 16, 2018
773d173
rimraf is not necessary
vweevers Dec 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,17 @@ Alternatively, you can initialize submodules inside the cloned folder:
$ git submodule update --init --recursive
```

### Publishing

1. Increment the version: `npm version ..`
2. Push to GitHub: `git push --follow-tags`
3. Wait for Travis and AppVeyor builds to complete
4. Download prebuilds into `./prebuilds`: `npm run download-prebuilds`
5. Optionally verify loading a prebuild: `rimraf build && npm t`
6. Optionally verify which files npm will include: `irish-pub`
7. Add changelog to the GitHub release
8. Finally: `npm publish`
vweevers marked this conversation as resolved.
Show resolved Hide resolved

### Windows

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!
Expand Down
2 changes: 2 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
"nyc": "^12.0.2",
"optimist": "~0.6.1",
"prebuildify": "^2.9.1",
"prebuildify-ci": "^1.0.4",
"readfiletree": "~0.0.1",
"remark-cli": "^5.0.0",
"remark-github": "^7.0.3",
Expand All @@ -47,6 +48,7 @@
"coverage": "nyc report --reporter=text-lcov | coveralls",
"rebuild": "node-gyp rebuild",
"prebuild": "prebuildify --napi --strip",
"download-prebuilds": "prebuildify-ci download",
"changelog": "remark CHANGELOG.md -o"
},
"remarkConfig": {
Expand Down