File tree Expand file tree Collapse file tree 4 files changed +65
-15
lines changed
Expand file tree Collapse file tree 4 files changed +65
-15
lines changed Original file line number Diff line number Diff line change 11# Change Log
22
3+ ## master
34### Features
45
56### Fixes
67
8+ ## 1.2.0 - 2015/05/11
9+ ### Features
10+ * Search API now returns all pages of results
11+ * Added ` Repository.listReleases `
12+
13+ Added functions for querying organization membership
14+ * ` Organization.listMembers `
15+ * ` Organization.isMember `
16+
17+ Added functions for issue comments
18+ * ` Issue.listComments `
19+ * ` Issue.getComment `
20+ * ` Issue.editComment `
21+ * ` Issue.deleteComment `
22+
23+ ### Fixes
24+ * all functions now return a Promise
25+
726## 1.1.0 - 2015/05/03
827### Features
928Added methods for commenting on Gists:
Original file line number Diff line number Diff line change 99Github.js provides a minimal higher-level wrapper around Github's API. It was concieved in the context of
1010[ Prose] [ prose ] , a content editor for GitHub.
1111
12- ## Docs
13- Read the [ docs] [ docs ]
12+ ## [ Read the docs] [ docs ]
1413
1514## Installation
16- Github.js is available from ` npm ` or (soon) [ cdnjs ] [ cdnjs ] .
15+ Github.js is available from ` npm ` or [ npmcdn ] [ npmcdn ] .
1716
18- ```
17+ ``` shell
1918npm install github-api
2019```
2120
21+ ``` html
22+ <!-- just github-api source (5.3kb) -->
23+ <script src =" //npmcdn.com/github-api/dist/GitHub.min.js" ></script >
24+
25+ <!-- standalone (20.3kb) -->
26+ <script src =" //npmcdn.com/github-api/dist/GitHub.bundle.min.js" ></script >
27+ ```
28+
2229## Compatibility
2330Github.js is tested on Node:
24- * 0.10
25- * 0.12
26- * 4.x
2731* 5.x
32+ * 4.x
33+ * 0.12
34+ * 0.10
2835
2936## GitHub Tools
3037
@@ -101,11 +108,11 @@ yahoo.getRepos(function(err, repos) {
101108})
102109```
103110
104- [ cdnjs ] : https://cdnjs.com/
105111[ codecov ] : https://codecov.io/github/michael/github?branch=master
106- [ travis-ci ] : https ://travis-ci.org/michael/ github
112+ [ docs ] : http ://michael.github.io/ github/
107113[ gitter ] : https://gitter.im/michael/github
108- [ npm-package ] : https://www.npmjs.com/package/github-api
114+ [ npm-package ] : https://www.npmjs.com/package/github-api/
115+ [ npmcdn ] : https://npmcdn.com/github-api/
109116[ prose ] : http://prose.io
117+ [ travis-ci ] : https://travis-ci.org/michael/github
110118[ xhr-link ] : http://blogs.msdn.com/b/ieinternals/archive/2010/05/13/xdomainrequest-restrictions-limitations-and-workarounds.aspx
111- [ docs ] : http://michael.github.io/github/
Original file line number Diff line number Diff line change 1616 "build" : " gulp build" ,
1717 "test" : " mocha --opts ./mocha.opts test/*.spec.js" ,
1818 "test-verbose" : " DEBUG=github* npm test" ,
19- "test-browser" : " " ,
2019 "lint" : " gulp lint" ,
21- "generate-docs" : " node_modules/.bin/jsdoc -c .jsdoc.json --verbose" ,
22- "codecov" : " node_modules/.bin/codecov" ,
23- "show-coverage-html" : " open coverage/lcov-report/index.html"
20+ "make-docs" : " node_modules/.bin/jsdoc -c .jsdoc.json --verbose" ,
21+ "release" : " ./release.sh"
2422 },
2523 "babel" : {
2624 "presets" : [
Original file line number Diff line number Diff line change 1+ #! /bin/bash
2+ # This is the automated release script
3+
4+ # bump the version
5+ echo " npm version $1 "
6+ npm version $1
7+ git push
8+ git push --tags
9+
10+ # start from a clean state
11+ rm -rf docs/ out/
12+ mkdir out
13+
14+ # build the docs
15+ npm run make-docs
16+ VERSION=` ls docs/github-api`
17+
18+ # switch to gh-pages and add the docs
19+ mv docs/github-api/* out/
20+ rm -rf docs/
21+
22+ git checkout gh-pages
23+ mv out/* docs/
24+ echo $VERSION >> _data/versions.csv
25+ git co -am " adding docs for v$VERSION "
26+ git push
You can’t perform that action at this time.
0 commit comments