codacy-badger/jira-api-resource

jira-api-resource

This ressource is still under construction. There is no stable release yet. Use at your own risk.

This Concourse resource allows a pipeline to interface with a Jira REST API in order to manager (create/update/delete) tickets.

Table of content

1. Resource Type Configuration
2. Source Configuration
   1. Required Parameters Definition
   2. Action Parameters Definition
      1. Add Comment

Resource Type Configuration

resource_types:
    - name: jira-api-resource
      type: docker-image
      source:
          repository: ... 
          tag: latest

Source Configuration

resources:
    - name: jira
      type: jira-resource
      source:
          url: https://...
          username: XXXX
          password: ((password-in-vault)

Firstly, here's a list of all required parameters:

Required Parameters Definition

Parameter	Description
url	The URL of the JIRA rest API to be used
user	The username of the account used to connect with the Jira rest API
password	The password of the specified user

Action Parameters Definition

Now to specify the action to take specify one and only one of the actions listed bellow:

Add Comment

The configuration to use for add a comment to the specified ticket is add-comment.

Example: