tangem/jira-action

jira-action GitHub Action

Table of Contents

• Usage
• Check version
• Create version
• Realise version
• Rename version
• Set Version To Issues
• Get Branch Summary
• Get Issues Summary

Usage

For login to Jira necessary to use

- name: Jira Login
  uses: atlassian/gajira-login@master
  env:
    JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
    JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}
    JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}

The required parameter is action which specifies the method to use.

Check Version

- name: Jira Check Version
  uses: tangem/jira-action@master
  with:
    action: checkVersion
    project: MM
    version: v1

Inputs

Name	Requirement	Description
project	required	Code of the project
version	required	Name of the version

Outputs

Name	Type	Description
result	boolean	Return true if version exist in project

Create Version

- name: Jira Create Version
  uses: tangem/jira-action@master
  with:
    action: createVersion
    project: MM
    version: v1

Inputs

Name	Requirement	Description
project	required	Code of the project
version	required	Name of the version

Outputs

Name	Type	Description
result	boolean	Return true if version was created

Realise Version

- name: Jira Realise Version
  uses: tangem/jira-action@master
  with:
    action: realiseVersion
    project: MM
    version: v1

Inputs

Name	Requirement	Description
project	required	Code of the project
version	required	Name of the version

Outputs

Name	Type	Description
result	boolean	Return true if version was created

Rename Version

- name: Jira Rename Version
  uses: tangem/jira-action@master
  with:
    action: renameVersion
    project: MM
    version: v1
    new-name: v2

Inputs

Name	Requirement	Description
project	required	Code of the project
version	required	Old Name of the version
new-name	required	New Name of the version

Outputs

Name	Type	Description
result	boolean	Return true if version was renamed

Set Version To Issues

- name: Jira Set Version To Issues
  uses: tangem/jira-action@master
  with:
    action: setVersionToIssues
    project: MM
    version: v1
    issues: '["AND-1","AND-2"]'

Inputs

Name	Requirement	Description
project	required	Code of the project
version	required	Name of the version
issues	required	Stringify array of issues keys

Outputs

Name	Type	Description
result	boolean	Return true if for all set version

Get Branch Summary

- name: Jira Get Branch Summary
  uses: tangem/jira-action@master
  with:
    action: getBranchSummary
    branch-name: IOS-2148 Call updateIsBackupAllowed

Inputs

Name	Requirement	Description
branch-name	required	The branch name

Outputs

Name	Type	Description
key	string/boolean	If a issue has been found, it will return a key. Otherwise return false
summary	string/boolean	If a issue has been found, it will return a Summary. Otherwise return false

Get Issues Summary

- name: Jira Get Issues Summary
  uses: tangem/jira-action@master
  with:
    action: getIssuesSummary
    issues: '["AND-1","AND-2"]'

Inputs

Name	Requirement	Description
issues	required	Stringify array of issues keys

Outputs

Name	Type	Description
result	string/boolean	If a issues has been found, it will return a Summary. Otherwise return false