UNPKG

2.01 kBMarkdownView Raw
1apeman-dev-commons-releasing
2===========
3
4[![Build Status][my_travis_badge_url]][my_travis_url]
5[![Code Climate][my_codeclimate_badge_url]][my_codeclimate_url]
6[![Code Coverage][my_codeclimate_coverage_badge_url]][my_codeclimate_url]
7[![npm version][my_npm_budge_url]][my_npm_url]
8
9apeman common module for releasing.
10
11
12Installation
13------------
14
15Install module via [npm][npm_url].
16
17```bash
18# Install as local module.
19$ npm install apeman-dev-commons-releasing --save
20```
21
22Usage
23-----
24
25### release
26
27Release a package.
28
29```javascript
30#!/usr/bin/env node
31
32/**
33 * Release this package.
34 */
35
36"use strict";
37
38var path = require('path'),
39 release = require('apeman-commons-releasing');
40
41var basedir = path.resolve(__dirname, '..');
42
43release([
44 "./ci/build.js",
45 "git_tag",
46 "npm_publish",
47 "version_up",
48 "git_push"
49], {
50 basedir: basedir
51});
52```
53
54License
55-------
56
57This software is released under the [MIT License][my_license_url].
58
59
60Links
61-----
62
63+ [apeman][apeman_url]
64+ [colorprint](https://www.npmjs.com/package/colorprint)
65
66[npm_url]: https://www.npmjs.com/
67[apeman_url]: https://github.com/apeman-repo/apeman
68[my_repo_url]: https://github.com/apeman-repo/apeman-dev-commons-releasing
69[my_travis_url]: http://travis-ci.org/apeman-repo/apeman-dev-commons-releasing
70[my_travis_badge_url]: http://img.shields.io/travis/apeman-repo/apeman-dev-commons-releasing.svg?style=flat
71[my_license_url]: https://github.com/apeman-repo/apeman-dev-commons-releasing/blob/master/LICENSE
72[my_codeclimate_url]: http://codeclimate.com/github/apeman-repo/apeman-dev-commons-releasing
73[my_codeclimate_badge_url]: http://img.shields.io/codeclimate/github/apeman-repo/apeman-dev-commons-releasing.svg?style=flat
74[my_codeclimate_coverage_badge_url]: http://img.shields.io/codeclimate/coverage/github/apeman-repo/apeman-dev-commons-releasing.svg?style=flat
75[my_npm_url]: http://www.npmjs.org/package/apeman-dev-commons-releasing
76[my_npm_budge_url]: http://img.shields.io/npm/v/apeman-dev-commons-releasing.svg?style=flat
\No newline at end of file