Skip to content

Commit 5783156

Browse files
committed
Document deployment process, update changelog for beta15
1 parent 5a67282 commit 5783156

File tree

3 files changed

+40
-3
lines changed

3 files changed

+40
-3
lines changed

CHANGELOG.md

+13
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
<a name="4.0.0-beta15"></a>
2+
# [4.0.0-beta15](https://github.com/documentationjs/documentation/compare/v4.0.0-beta14...v4.0.0-beta15) (2016-11-23)
3+
4+
### Fixes
5+
6+
* Infer class augments tag in cases like `Foo extends React.Component`
7+
8+
### Features
9+
10+
* **config:** add file property for notes ([#614](https://github.com/documentationjs/documentation/issues/614)) ([d96aa47](https://github.com/documentationjs/documentation/commit/d96aa47)), closes [#609](https://github.com/documentationjs/documentation/issues/609)
11+
12+
13+
114
## 4.0.0-beta14
215

316
* Highlight all Markdown, not just examples. Fixes #610

CONTRIBUTING.md

+18-2
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,22 @@ Declaring formal releases remains the prerogative of the project maintainer.
2424

2525
This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change.
2626

27-
-----------------------------------------
28-
2927
[this approach is totally cribbed from the excellent LevelUP project](https://github.com/rvagg/node-levelup/blob/master/CONTRIBUTING.md)
28+
29+
----
30+
31+
## Releasing
32+
33+
documentation aims to **release often**. We use [standard-changelog](https://github.com/conventional-changelog/standard-changelog)
34+
to generate CHANGELOG.md entries and [commitizen](https://github.com/commitizen/cz-cli) to standardize
35+
commit messages. Pull Request messages should be standardized to commitizen syntax (aka angular standard)
36+
before merge.
37+
38+
Release process:
39+
40+
* Confirm that `master` passes CI tests
41+
* Bump version in `package.json`
42+
* Run `npm run changelog`
43+
* Add updated CHANGELOG.md to master
44+
* Push commits
45+
* npm publish

package.json

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "documentation",
33
"description": "a documentation generator",
4-
"version": "4.0.0-beta14",
4+
"version": "4.0.0-beta15",
55
"author": "Tom MacWright",
66
"bin": {
77
"documentation": "./bin/documentation.js"
@@ -44,6 +44,7 @@
4444
"remark-toc": "^3.0.0",
4545
"remote-origin-url": "0.4.0",
4646
"resolve": "^1.1.6",
47+
"standard-changelog": "0.0.1",
4748
"stream-array": "^1.1.0",
4849
"strip-json-comments": "^2.0.0",
4950
"tiny-lr": "^0.2.1",
@@ -58,6 +59,7 @@
5859
},
5960
"devDependencies": {
6061
"chdir": "0.0.0",
62+
"cz-conventional-changelog": "1.2.0",
6163
"documentation-schema": "0.0.1",
6264
"eslint": "^3.1.0",
6365
"fs-extra": "^0.30.0",
@@ -84,7 +86,13 @@
8486
"scripts": {
8587
"lint": "eslint bin lib index.js test",
8688
"doc": "documentation build index.js -f md --access=public > docs/NODE_API.md",
89+
"changelog": "standard-changelog -i CHANGELOG.md -s",
8790
"self-lint": "node ./bin/documentation.js lint",
8891
"test": "npm run lint && npm run self-lint && tap -t 120 --coverage --nyc-arg=--cache test/*.js test/lib test/streams"
92+
},
93+
"config": {
94+
"commitizen": {
95+
"path": "./node_modules/cz-conventional-changelog"
96+
}
8997
}
9098
}

0 commit comments

Comments
 (0)