Skip to content

Commit 034c97b

Browse files
committed
Stable Version 2.3.0
1 parent 37d42b3 commit 034c97b

19 files changed

+1061
-708
lines changed

.jshintrc

Lines changed: 0 additions & 34 deletions
This file was deleted.

.npmignore

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Logs
2+
logs
3+
*.log
4+
5+
# Runtime data
6+
pids
7+
*.pid
8+
*.seed
9+
10+
# Directory for instrumented libs generated by jscoverage/JSCover
11+
lib-cov
12+
13+
# Coverage directory used by tools like istanbul
14+
coverage
15+
16+
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
17+
.grunt
18+
19+
# Compiled binary addons (http://nodejs.org/api/addons.html)
20+
build/Release
21+
22+
# Dependency directory
23+
# Commenting this out is preferred by some people, see
24+
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
25+
node_modules
26+
27+
# Users Environment Variables
28+
.lock-wscript
29+
30+
.idea/
31+
*.iml
32+
coverage/
33+
src/
34+
test/
35+
mocha.start.js
36+
webpack.config.js

.travis.yml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
1+
sudo: false
12
language: node_js
23
node_js:
4+
- "stable"
5+
- "0.12"
36
- "0.10"
47
services:
58
- redis-server
6-
before_install:
7-
- npm install -g npm
8-
- npm install -g grunt-cli
9-
script:
10-
- grunt test
11-
- grunt coveralls || true

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
##### 2.3.0 - 11 November 2015
2+
3+
###### Other
4+
- Rebuilt with Babel 6
5+
- Dropped Grunt
6+
- Integrated js-data-adapter-tests
7+
18
##### 2.2.0 - 09 September 2015
29

310
###### Backwards compatible API changes

CONTRIBUTING.md

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,47 @@
11
# Contributing Guide
22

3-
First, support is handled via the [Gitter Channel](https://gitter.im/js-data/js-data) and the [Mailing List](https://groups.io/org/groupsio/jsdata). Ask your questions there.
3+
First, support is handled via the [Slack Channel](http://slack.js-data.io) and
4+
the [Mailing List](https://groups.io/org/groupsio/jsdata). Ask your questions
5+
there.
46

5-
When submitting issues on GitHub, please include as much detail as possible to make debugging quick and easy.
7+
When submitting issues on GitHub, please include as much detail as possible to
8+
make debugging quick and easy.
69

7-
- good - Your versions of js-data, js-data-redis, etc., relevant console logs/error, code examples that revealed the issue
8-
- better - A [plnkr](http://plnkr.co/), [fiddle](http://jsfiddle.net/), or [bin](http://jsbin.com/?html,output) that demonstrates the issue
9-
- best - A Pull Request that fixes the issue, including test coverage for the issue and the fix
10+
- good - Your versions of js-data, js-data-redis, etc., relevant console
11+
logs/error, code examples that revealed the issue
12+
- better - A [plnkr](http://plnkr.co/), [fiddle](http://jsfiddle.net/), or
13+
[bin](http://jsbin.com/?html,output) that demonstrates the issue
14+
- best - A Pull Request that fixes the issue, including test coverage for the
15+
issue and the fix
1016

1117
[Github Issues](https://github.com/js-data/js-data-redis/issues).
1218

1319
#### Submitting Pull Requests
1420

15-
1. Contribute to the issue/discussion that is the reason you'll be developing in the first place
21+
1. Contribute to the issue/discussion that is the reason you'll be developing in
22+
the first place
1623
1. Fork js-data-redis
1724
1. `git clone git@github.com:<you>/js-data-redis.git`
18-
1. `cd js-data-redis; npm install; bower install;`
25+
1. `cd js-data-redis; npm install;`
1926
1. Write your code, including relevant documentation and tests
20-
1. Run `grunt test` (build and test)
27+
1. Run `npm test` (build and test)
28+
- You need io.js or Node 4.x that includes generator support without a flag
2129
1. Your code will be linted and checked for formatting, the tests will be run
22-
1. The `dist/` folder & files will be generated, do NOT commit `dist/*`! They will be committed when a release is cut.
30+
1. The `dist/` folder & files will be generated, do NOT commit `dist/*`! They
31+
will be committed when a release is cut.
2332
1. Submit your PR and we'll review!
24-
1. Thanks!
33+
1. Thanks!
34+
35+
#### Have write access?
36+
37+
Here's how to make a release on the `master` branch:
38+
39+
1. Bump `package.json` to the appropriate version.
40+
1. `npm test` must succeed.
41+
1. This time, the built `dist/js-data-redis.js` file _will_ be committed, so stage its changes.
42+
1. Mention the release version in the commit message, e.g. `Stable Version 1.2.3`
43+
1. Push to master.
44+
1. Create a git tag. Name it the version of the release, e.g. `1.2.3`
45+
- Easiest way is to just create a GitHub Release, which will create the tag for you. Name the Release and the git tag the same thing.
46+
1. `git fetch origin` if you tagged it via GitHub Release, so you can get the tag on your local machine.
47+
1. `npm publish .` (Make sure you got the version bumped correctly!)

Gruntfile.js

Lines changed: 0 additions & 96 deletions
This file was deleted.

README.md

Lines changed: 50 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,14 @@
11
<img src="https://raw.githubusercontent.com/js-data/js-data/master/js-data.png" alt="js-data logo" title="js-data" align="right" width="64" height="64" />
22

3-
## js-data-redis [![npm version](https://img.shields.io/npm/v/js-data-redis.svg?style=flat-square)](https://www.npmjs.org/package/js-data-redis) [![Travis CI](https://img.shields.io/travis/js-data/js-data-redis.svg?style=flat-square)](https://travis-ci.org/js-data/js-data-redis) [![npm downloads](https://img.shields.io/npm/dm/js-data-redis.svg?style=flat-square)](https://www.npmjs.org/package/js-data-redis) [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/js-data/js-data-redis/blob/master/LICENSE)
3+
## js-data-redis [![Slack Status][sl_b]][sl_l] [![npm version][npm_b]][npm_l] [![Travis CI][travis_b]][travis_l] [![npm downloads][dn_b]][dn_l] [![Coverage Status][cov_b]][cov_l] [![Codacy][cod_b]][cod_l]
44

55
Redis adapter for [js-data](http://www.js-data.io/).
66

77
### API Documentation
88
[DSRedisAdapter](http://www.js-data.io/docs/dsredisadapter)
99

10-
### Project Status
11-
12-
__Latest Release:__ [![Latest Release](https://img.shields.io/github/release/js-data/js-data-redis.svg?style=flat-square)](https://github.com/js-data/js-data-redis/releases)
13-
14-
__Status:__
15-
16-
[![Codacity](https://img.shields.io/codacy/64cca2890a594370a5c9f4d5c0e3fcc3.svg?style=flat-square)](https://www.codacy.com/public/jasondobry/js-data-redis/dashboard)
17-
18-
__Supported Platforms:__
19-
20-
[![node version](https://img.shields.io/badge/Node-0.10%2B-green.svg?style=flat-square)](https://github.com/js-data/js-data)
21-
2210
### Quick Start
23-
`npm install --save js-data js-data-redis`.
11+
`npm install --save js-data js-data-redis redis`.
2412

2513
```js
2614
var JSData = require('js-data');
@@ -38,11 +26,13 @@ store.registerAdapter('redis', adapter, { default: true });
3826
// "store" will now use the Redis adapter for all async operations
3927
```
4028

29+
Read about using [JSData on the Server](http://www.js-data.io/docs/jsdata-on-the-server).
30+
4131
### Changelog
4232
[CHANGELOG.md](https://github.com/js-data/js-data-redis/blob/master/CHANGELOG.md)
4333

4434
### Community
45-
- [Gitter Channel](https://gitter.im/js-data/js-data) - Better than IRC!
35+
- [Slack Channel](http://slack.js-data.io) - Better than IRC!
4636
- [Announcements](http://www.js-data.io/blog)
4737
- [Mailing List](https://groups.io/org/groupsio/jsdata) - Ask your questions!
4838
- [Issues](https://github.com/js-data/js-data-redis/issues) - Found a bug? Feature request? Submit an issue!
@@ -51,29 +41,52 @@ store.registerAdapter('redis', adapter, { default: true });
5141

5242
### Contributing
5343

54-
First, support is handled via the [Gitter Channel](https://gitter.im/js-data/js-data) and the [Mailing List](https://groups.io/org/groupsio/jsdata). Ask your questions there.
44+
First, support is handled via the [Slack Channel](http://slack.js-data.io) and
45+
the [Mailing List](https://groups.io/org/groupsio/jsdata). Ask your questions
46+
there.
5547

56-
When submitting issues on GitHub, please include as much detail as possible to make debugging quick and easy.
48+
When submitting issues on GitHub, please include as much detail as possible to
49+
make debugging quick and easy.
5750

58-
- good - Your versions of js-data, js-data-redis, etc., relevant console logs/error, code examples that revealed the issue
59-
- better - A [plnkr](http://plnkr.co/), [fiddle](http://jsfiddle.net/), or [bin](http://jsbin.com/?html,output) that demonstrates the issue
60-
- best - A Pull Request that fixes the issue, including test coverage for the issue and the fix
51+
- good - Your versions of js-data, js-data-redis, etc., relevant console
52+
logs/error, code examples that revealed the issue
53+
- better - A [plnkr](http://plnkr.co/), [fiddle](http://jsfiddle.net/), or
54+
[bin](http://jsbin.com/?html,output) that demonstrates the issue
55+
- best - A Pull Request that fixes the issue, including test coverage for the
56+
issue and the fix
6157

6258
[Github Issues](https://github.com/js-data/js-data-redis/issues).
6359

6460
#### Submitting Pull Requests
6561

66-
1. Contribute to the issue/discussion that is the reason you'll be developing in the first place
62+
1. Contribute to the issue/discussion that is the reason you'll be developing in
63+
the first place
6764
1. Fork js-data-redis
6865
1. `git clone git@github.com:<you>/js-data-redis.git`
69-
1. `cd js-data-redis; npm install; bower install;`
66+
1. `cd js-data-redis; npm install;`
7067
1. Write your code, including relevant documentation and tests
71-
1. Run `grunt test` (build and test)
68+
1. Run `npm test` (build and test)
69+
- You need io.js or Node 4.x that includes generator support without a flag
7270
1. Your code will be linted and checked for formatting, the tests will be run
73-
1. The `dist/` folder & files will be generated, do NOT commit `dist/*`! They will be committed when a release is cut.
71+
1. The `dist/` folder & files will be generated, do NOT commit `dist/*`! They
72+
will be committed when a release is cut.
7473
1. Submit your PR and we'll review!
7574
1. Thanks!
7675

76+
#### Have write access?
77+
78+
Here's how to make a release on the `master` branch:
79+
80+
1. Bump `package.json` to the appropriate version.
81+
1. `npm test` must succeed.
82+
1. This time, the built `dist/js-data-redis.js` file _will_ be committed, so stage its changes.
83+
1. Mention the release version in the commit message, e.g. `Stable Version 1.2.3`
84+
1. Push to master.
85+
1. Create a git tag. Name it the version of the release, e.g. `1.2.3`
86+
- Easiest way is to just create a GitHub Release, which will create the tag for you. Name the Release and the git tag the same thing.
87+
1. `git fetch origin` if you tagged it via GitHub Release, so you can get the tag on your local machine.
88+
1. `npm publish .` (Make sure you got the version bumped correctly!)
89+
7790
### License
7891

7992
The MIT License (MIT)
@@ -97,3 +110,16 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
97110
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
98111
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
99112
SOFTWARE.
113+
114+
[sl_b]: http://slack.js-data.io/badge.svg
115+
[sl_l]: http://slack.js-data.io
116+
[npm_b]: https://img.shields.io/npm/v/js-data-redis.svg?style=flat
117+
[npm_l]: https://www.npmjs.org/package/js-data-redis
118+
[travis_b]: https://img.shields.io/travis/js-data/js-data-redis.svg
119+
[travis_l]: https://travis-ci.org/js-data/js-data-redis
120+
[dn_b]: https://img.shields.io/npm/dm/js-data-redis.svg?style=flat
121+
[dn_l]: https://www.npmjs.org/package/js-data-redis
122+
[cov_b]: https://img.shields.io/coveralls/js-data/js-data-redis/master.svg?style=flat
123+
[cov_l]: https://coveralls.io/github/js-data/js-data-redis?branch=master
124+
[cod_b]: https://img.shields.io/codacy/64cca2890a594370a5c9f4d5c0e3fcc3.svg
125+
[cod_l]: https://www.codacy.com/app/jasondobry/js-data-redis/dashboard

0 commit comments

Comments
 (0)