Skip to content

Commit d43e483

Browse files
committed
Move dist/ files to another branch
1 parent 04e27fe commit d43e483

16 files changed

+52
-10196
lines changed

.github/CONTRIBUTING.md

+28-12
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,43 @@
1-
# Contributing
1+
# Contributing to js-data core
22

3-
[Read the Contributing Guide](http://js-data.io/docs/contributing).
3+
[Read the general Contributing Guide](http://js-data.io/docs/contributing).
44

5-
## Support
5+
## Project structure
66

7-
[Find out how to Get Support](http://js-data.io/docs/support).
7+
* `dist/` - Contains final build files for distribution (js-data-http)
8+
* `doc/` - Output folder for JSDocs
9+
* `fetch/` - Contains js-data-fetch package files
10+
* `dist/` - Contains final build files for distribution (js-data-fetch)
11+
* `node/` - Contains js-data-http-node package files
12+
* `dist/` - Contains final build files for distribution (js-data-http-node)
13+
* `scripts/ - Various build scripts
14+
* `src/` - Project source code
15+
* `test/` - Project tests
816

9-
## Community
17+
## Clone, build & test
1018

11-
[Explore the Community](http://js-data.io/docs/community).
19+
1. `clone git@github.com:js-data/js-data-http.git`
20+
1. `cd js-data-http`
21+
1. `npm install`
22+
1. `npm test` - Build and test
1223

13-
### Have write access?
14-
15-
To cut a release:
24+
## To cut a release
1625

1726
1. Checkout master
1827
1. Bump version in `package.json` appropriately
19-
1. Run `npm run release`
2028
1. Update `CHANGELOG.md` appropriately
21-
1. Commit and push changes, including the `dist/` folder
29+
1. Run `npm run release`
30+
1. Commit and push changes
31+
1. Checkout `release`, merge `master` into `release`
32+
1. Run `npm run release` again
33+
1. Commit and push changes
2234
1. Make a GitHub release
35+
- tag from `release` branch
2336
- set tag name to version
2437
- set release name to version
2538
- set release body to changelog entry for the version
26-
- attach the files in the `dist/` folder
39+
- upload the files in the `dist/` folder
2740
1. `npm publish .`
41+
1. checkout `master`
42+
43+
See also [Community & Support](http://js-data.io/docs/community).

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
dist/*.js
2+
dist/*.map
13
bower_components/
24

35
.idea/

CHANGELOG.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
##### 3.0.0-beta.3 - 28 April 2016
22

33
###### Breaking changes
4-
- js-data-http.js no longer exports a default module, you must now do:
4+
- js-data-http/js-data-fetch/js-data-http-node no longer export a default module, instead you must do:
55
- `import {HttpAdapter} from 'js-data-http'
66
- `var HttpAdapter = require('js-data-http').HttpAdapter
77
- `var adapter = new window.JSDataHttp.HttpAdapter()`
88
- `define(['js-data-http'], function (JSDataHttp) { var adapter = new window.JSDataHttp.HttpAdapter(); })
9+
- Removed `dist/` files from the `master` branch to a `release` branch to cut down on noise
910

1011
###### Backwards compatible changes
1112
- Added `typings` field to `package.json`

README.md

+16-19
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,33 @@
44

55
[![Slack Status][sl_b]][sl_l]
66
[![npm version][npm_b]][npm_l]
7-
[![Circle CI][circle_b]][circle_l]
87
[![npm downloads][dn_b]][dn_l]
8+
[![Circle CI][circle_b]][circle_l]
99
[![Coverage Status][cov_b]][cov_l]
10-
[![Codacy][cod_b]][cod_l]
1110

1211
This repo contains HTTP adapters for [js-data](http://www.js-data.io/):
1312

14-
- js-data-http - HTTP (XHR, includes [axios][axios]) adapter for js-data in the
15-
browser. Capable of using `window.fetch` instead of axios.
16-
- js-data-fetch - Same as js-data-http but doesn't include axios and will use
13+
- js-data-http - HTTP (XHR, includes [`axios`][axios]) adapter for JSData in the
14+
browser. Capable of using `window.fetch` instead of axios. __Only works in the browser__.
15+
- js-data-fetch - Same as `js-data-http` but _does not_ include `axios` and will use
1716
`window.fetch` if available and if you don't provide your own http library.
18-
- js-data-http-node - Same as js-data-http but runs on Node.js. Depends on axios
19-
and will use axios unless you provide a different http library.
17+
- js-data-http-node - Same as `js-data-http` but runs on Node.js. Depends on `axios`
18+
and will use `axios` unless you provide a different http library.
2019

2120
Tested on IE9, Chrome 46, Firefox 41 & Safari 7.1 using
2221
<img src="https://raw.githubusercontent.com/js-data/js-data-localstorage/master/bs.jpg" alt="bs logo" title="browserstack" width="150" height="35" style="vertical-align: middle" />
2322

24-
To get started, visit the main website at __[http://js-data.io](http://www.js-data.io/v3.0/docs/js-data-http)__.
23+
To get started, visit the main website at __[http://js-data.io](http://www.js-data.io)__.
2524

2625
## Links
2726

28-
* [Quick start](http://www.js-data.io/v3.0/docs/js-data-http)
29-
* [Guides and Tutorials](http://www.js-data.io/v3.0/docs/home)
30-
* [API Reference Docs](http://api.js-data.io/js-data-http)
31-
* [Community](http://js-data.io/docs/community)
32-
* [Support](http://js-data.io/docs/support)
33-
* [Contributing](http://js-data.io/docs/contributing)
27+
* [Quick start](http://www.js-data.io/v3.0/docs/home#quick-start) - Get started in 5 minutes
28+
* [Guides and Tutorials](http://www.js-data.io/v3.0/docs/home) - Learn how to use JSData
29+
* [HttpAdapter Guide](http://www.js-data.io/v3.0/docs/js-data-http) - Learn how to use the HttpAdapter
30+
* [API Reference Docs](http://api.js-data.io) - Explore components, methods, options, etc.
31+
* [Community & Support](http://js-data.io/docs/community) - Find solutions and chat with the community
32+
* [General Contributing Guide](http://js-data.io/docs/contributing) - Give back and move the project forward
33+
* [Contributing to js-data-http](https://github.com/js-data/js-data-http/blob/master/.github/CONTRIBUTING.md)
3434

3535
## License
3636

@@ -44,14 +44,11 @@ Copyright (c) 2014-2016 js-data-http project authors
4444

4545
[sl_b]: http://slack.js-data.io/badge.svg
4646
[sl_l]: http://slack.js-data.io
47-
[so]: http://stackoverflow.com/questions/tagged/jsdata
4847
[npm_b]: https://img.shields.io/npm/v/js-data-http.svg?style=flat
4948
[npm_l]: https://www.npmjs.org/package/js-data-http
50-
[circle_b]: https://img.shields.io/circleci/project/js-data/js-data-http/master.svg?style=flat
51-
[circle_l]: https://circleci.com/gh/js-data/js-data-http/tree/master
5249
[dn_b]: https://img.shields.io/npm/dm/js-data-http.svg?style=flat
5350
[dn_l]: https://www.npmjs.org/package/js-data-http
51+
[circle_b]: https://img.shields.io/circleci/project/js-data/js-data-http/master.svg?style=flat
52+
[circle_l]: https://circleci.com/gh/js-data/js-data-http/tree/master
5453
[cov_b]: https://img.shields.io/codecov/c/github/js-data/js-data-http/3.0.svg?style=flat
5554
[cov_l]: https://codecov.io/github/js-data/js-data-http
56-
[cod_b]: https://img.shields.io/codacy/3931bbd8d838463297f70640aa78251b.svg
57-
[cod_l]: https://www.codacy.com/app/jasondobry/js-data-http/dashboard

0 commit comments

Comments
 (0)