Skip to content

Latest commit

 

History

History
66 lines (41 loc) · 1.8 KB

README.md

File metadata and controls

66 lines (41 loc) · 1.8 KB

danger-plugin-rally

Build Status npm version semantic-release code style: prettier

tools for linking rally stories to pull requests

Usage

Install:

npm install --save-dev danger-plugin-rally

At a glance:

// dangerfile.js
import rally from 'danger-plugin-rally'

rally();

This plugin:

  • Provides links to stories, tasks, and defects mentioned in commit messages, PR title, and PR description.
  • Warns if no stories, tasks, or defects are found

Note: Only works with Bitbucket server right now. More to come!

API

rally([options])

options

requirePound

Type: Boolean

Default: false

Fails if story, task, or defect numbers are not prefixed with # in the commit body. This useful if you are generating ticket links with standard-version or semantic-release

bodyOnly

Type: Boolean

Default: false

Fails if story, task, or defect numbers mentioned in the commit header, rather than the body.

domain

Type: String

Default: 'https://rally1.rallydev.com'

Hostname for your rally instance

Changelog

See the GitHub release history.

Contributing

See CONTRIBUTING.md.