ci-jira
v0.0.7
Published
Node package to add CI features for simple JIRA transactions
Downloads
4
Readme
ci-jira
Package to add CI features for simple JIRA and BitBucket Cloud transactions
Installation
npm install @jovermars/ci-jira
Usage
Atlassian
To be able to connect to Atlassian JIRA or BitBucket the following parameters need to be specified. By default https will be selected as protocol, but this can be overwritten if necessary.
Options
- username: Atlassian JIRA or BitBucket username
- password: Password for the username
fix-version
Assigns the issues to the specified vrsion in the JIRA project. Return the number of issues that have been updated with the fixVersion
Remarks
If the version of the JIRA project of the tickets does not exist yet it will be created in the project. If tickets from multiple projects are specified then fixversion creates the version in each project.
All issues will be added to the version if it has not been assigned to the version yet. Other versions in the fixversion value of the issue will be respected.
Example
grunt fix-version --versionName=1.0.Test --issues=DM-1,DM-2 --username=john.doe --password=secret --host=test.jira.com
Options
- host: Hostname of JIRA instance (e.g. company.jira.com)
- versionName: Name of the version to be created in the related JIRA project
- issues: Comma separated list of JIRA issues to be updated
merged-between
Returns all JIRA issues numbers between two commits by connecting to the BitBucket cloud API and analysing all commit messages in between
Example
grunt merged-between --owner=company_name --slug=test_repository --hashFrom=f42ed1ffd1ddbf83fa66ebc1ddb380a0401ed3b1 --hashTo=6a49aab7fcae427b77631b13cb0c58e924151196 [email protected]=secret --branch=master
Options
- owner: Name of the owner of the repository. This value can be found in the url of the repository in BitBucket
- slug: Name of the repository
- toFrom: The newest SHA1 of the commit on the branch in the repository
- hashFrom: The oldest SHA1 of the commit on the branch in the repository
- branch (optional): Default master. Name of the branch to analyse
merged-since
Returns all JIRA issues numbers until and including the specified commit by connecting to the BitBucket cloud API and analysing all commit messages
Example
grunt merged-till--owner=company_name --slug=test_repository --hashTo=6a49aab7fcae427b77631b13cb0c58e924151196 [email protected]=secret --branch=master
Options
- see merged-between
Tests
npm test