Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/okunishinishi/node-taggit
Node.js module to create a tag on remote git with version number in package.json (or bower.json)
https://github.com/okunishinishi/node-taggit
Last synced: 2 months ago
JSON representation
Node.js module to create a tag on remote git with version number in package.json (or bower.json)
- Host: GitHub
- URL: https://github.com/okunishinishi/node-taggit
- Owner: okunishinishi
- License: mit
- Created: 2015-07-12T04:38:37.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-02-24T00:54:06.000Z (almost 6 years ago)
- Last Synced: 2024-10-05T21:45:30.011Z (4 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/taggit
- Size: 55.7 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
taggit
==========
[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[bd_repo_url]: https://github.com/okunishinishi/node-taggit
[bd_travis_url]: http://travis-ci.org/okunishinishi/node-taggit
[bd_travis_shield_url]: http://img.shields.io/travis/okunishinishi/node-taggit.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/okunishinishi/node-taggit
[bd_travis_com_shield_url]: https://api.travis-ci.com/okunishinishi/node-taggit.svg?token=
[bd_license_url]: https://github.com/okunishinishi/node-taggit/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/okunishinishi/node-taggit
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/okunishinishi/node-taggit.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/okunishinishi/node-taggit.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/okunishinishi/node-taggit
[bd_gemnasium_shield_url]: https://gemnasium.com/okunishinishi/node-taggit.svg
[bd_npm_url]: http://www.npmjs.org/package/taggit
[bd_npm_shield_url]: http://img.shields.io/npm/v/taggit.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
Create a tag on remote git with version number in package.json (or bower.json)
Installation
-----
```bash
npm install taggit --save-dev
```
Usage
---------
Call `taggit()` at project root path where `package.json` exists.
```javascript
'use strict'
let basedir = __dirname;
process.chdir(basedir) //Move to project root.
const taggit = require('taggit')
// Create remote git tag named with package.json version. (eg. v1.0.0)
taggit({
// Options
}, (err) => {
/*...*/
})
```
Options
---------
| Key | Default | Description |
| --- | --- | --- |
| tag | | Name of tag. By default, name is resolved form package.json. |
| cwd | | Working directory path. |
Using with CLI
---------
Install as a global module.
```bash
$ npm install taggit -g
```
Then,
```bash
$ taggit -t "v0.0.5"
```
License
-------
This software is released under the [MIT License](https://github.com/okunishinishi/node-taggit/blob/master/LICENSE).