https://github.com/juliangieseke/semantic-release-jira

Easily update JIRA Issues with release information
https://github.com/juliangieseke/semantic-release-jira

cd ci jira semantic-release

Last synced: about 2 months ago
JSON representation

Easily update JIRA Issues with release information

• Host: GitHub
• URL: https://github.com/juliangieseke/semantic-release-jira
• Owner: juliangieseke
• Archived: true
• Created: 2018-08-21T16:17:44.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-09-20T23:35:59.000Z (over 3 years ago)
• Last Synced: 2024-10-31T13:45:40.446Z (2 months ago)
• Topics: cd, ci, jira, semantic-release
• Language: JavaScript
• Homepage:
• Size: 1.52 MB
• Stars: 5
• Watchers: 0
• Forks: 3
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# semantic-release-jira [![Build Status](https://travis-ci.org/juliangieseke/semantic-release-jira.svg?branch=master)](https://travis-ci.org/juliangieseke/semantic-release-jira)

---

👩‍🔬 Please be aware that this package is still experimental —

changes to the interface and underlying implementation are likely,

and future development or maintenance is not guaranteed.

---

This package provides a simple way to label JIRA issues with releases.

Currently, it is only compatible with JIRA rest API v2 and login:password authentication

## Example

In `.releaserc`:

```js

{

  "verifyConditions": [

    "@semantic-release/github",

    "@semantic-release/npm",

    "semantic-release-jira"

  ]

  "success": [

    "@semantic-release/github",

    ["semantic-release-jira", {

      "auth": {

        "type": "Bearer",

        "userEnvVar": "JIRA_USER",

        "passEnvVar": "JIRA_PASS",

        "tokenEnvVar": "JIRA_TOKEN"

      }

      "actions": [

        {

          "method": "POST",

          "url": "https://jira.example.com/rest/api/2/versions",

          "body": '{ "name": "${version}", "archived": false, "released": true, "project": "${project}"}'

        },

        {

          "method": "PUT",

          "url": "https://jira.example.com/rest/api/2/issue/${issueKey}",

          "body": '{"update":{"labels":[{"add":"some-component:${version}"}]}}'

        },

        {

          "method": "PUT",

          "url": "https://jira.example.com/rest/api/2/issue/${issueKey}",

          "body": '{"update":{"fixVersions":[{"add":{"name":"Some Component ${version}"}}]}}'

        },

        {

          "method":"POST",

          "url": "https://jira.d2iq.com/rest/api/2/issue/${issueKey}/transitions",

          "body": '{"transition":{"id":151}}'

        }

      ]

    }]

  ]

}

```

## Environment Variables

### `JIRA_USER`

User to login with JIRA, to be passed in as environment variable.

### `JIRA_PASS`

Password to login with JIRA, to be passed in as environment variable.

## Options

### `verifyConditions` step

This step doesnt support any options.

### `success` step

See example above.