UNPKG

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