Skip to content

Commit

Permalink
Add release docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chasenlehara committed Dec 1, 2017
1 parent 7aeeecd commit 0104cb9
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,20 @@ npm run document
This will create a `docs/` folder that contains a browsable site with all of your documentation.

With the dev server running, you can view the docs at http://localhost:8080/docs/

### Making a release

Run any of following commands to make a release:

```shell
npm version prerelease
npm version patch
npm version minor
npm version major
```

This will run the tests, make a build, bump the version number, and push the git
tag for the release.

See the [Making releases](https://canjs.com/doc/guides/contributing/releases.html#Makingreleases)
docs to learn how to decide which type of version you should release.
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
"jshint": "jshint ./*.js ./helpers/*.js --config",
"lint": "fixpack && npm run jshint",
"preversion": "npm test && npm run build",
"postversion": "git push --follow-tags",
"test": "npm run detect-cycle && npm run lint && npm run testee",
"testee": "testee test.html --browsers firefox"
}
Expand Down

0 comments on commit 0104cb9

Please sign in to comment.