项目作者: bahmutov

项目描述 :
Parses commit message to find all "fixes", "closes" and "resolves" issue numbers
高级语言: JavaScript
项目地址: git://github.com/bahmutov/commit-closes.git
创建时间: 2017-07-07T01:22:37Z
项目社区:https://github.com/bahmutov/commit-closes

开源协议:

下载


commit-closes

Parses commit message to find all “fixes”, “closes” and “resolves” issue numbers

NPM

Build status
semantic-release
js-standard-style

Commit parsing code based on
conventional-changelog

You can close GitHub issues with commit text. For example

  1. git commit -m "this feature closes #4"

will close issue 4 when pushed to github. This module can find issues closed
given commit subject and body. All forms are supported:
fix|fixes|fixed|close|closes|closed|resolve|resolves|resolved
case-insensitive.

Install

Requires Node version 6 or above.

  1. npm install --save commit-closes

Use

Give this function commit subject and optional body and it will return list
of closed issue numbers. If no issues is closed, returns empty list

  1. const commitCloses = require('commit-closes')
  2. const closed = commitCloses('this is subject', `
  3. this commit closes #2
  4. and resolves #21, #4
  5. and fixed #10
  6. `)
  7. // closed is [2, 21, 4, 10]

Small print

Author: Gleb Bahmutov gleb.bahmutov@gmail.com © 2017

License: MIT - do anything with the code, but don’t blame me if it does not work.

Support: if you find any problems with this module, email / tweet /
open issue on Github

MIT License

Copyright (c) 2017 Gleb Bahmutov gleb.bahmutov@gmail.com

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the “Software”), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.