Skip to content

Latest commit

 

History

History
126 lines (83 loc) · 3.46 KB

README.md

File metadata and controls

126 lines (83 loc) · 3.46 KB

Jira report tool service

It is a REST service for getting Jira issues, generating reports on them, generating release notes.

Configuration

Fill the jira.url in report-service/application.yml file. See details below

Fill your Jira auth data. Choose one of:

  • create env variable JIRA_AUTH_BASIC
  • fill the jira.auth.basic in report-service/application.yml file. See details below.

Params

application.yml

jira.url

Required
Type: String

Url for Jira.

jira.auth.basic

Required
Type: String
Env variable: JIRA_AUTH_BASIC

Your auth data for Jira. It should be the result of "Basic " + base64 (login + ":" + password)
For example:

jira.auth.basic=Basic TW9ya292a0E6bXlTdXBlclBhc3M=
jira.search.default.limit

Required
Type: Int

Default limit on the number of returned issues from Jira.

jira.search.default.comment.test.case.start

Required
Type: String

String to search test cases in issue comments, used as comment.startsWith("\${jira.comment.test.case.start}")
For example:

jira.comment.test.case.start=Сценарий для тестирования на препроде
jira.search.default.comment.deploy.instruction.start

Required
Type: String

String to search deploy instructions in issue comments, used as comment.startsWith("\${jira.comment.deploy.instruction.start}")
For example:

jira.comment.deploy.instruction.start=Инструкция по установке
auth.encoder.strength

Required
Type: Int
Env variable: ENCODER_STRENGTH

Strength the log rounds to use by BCryptPasswordEncoder, between 4 and 31

auth.valid.token

Required
Type: String
Env variable: TOKEN

Key string for checking permissions in requests. It should be sent as the secret code in Authorization header for each request.

Usage

There are examples of common requests in jira-report-tools/src/test/kotlin/ru/morkovka/report/requestExample/service/

Get issues by jql search

Type: GET
Url: /api/task/byJql?jql={jql}&limit={limit}
Returns a list of representation of the issues for the given jql (Jira query language) search.

Get issue by issueIdOrKey

Type: GET
Url: /api/task/byKey?jiraKey={issueIdOrKey}
Returns a representation of the issue for the given issue key.

Get issues by fixVersion

Type: GET
Url: /api/task/byRelease?jiraProject={jiraProject}&jiraRelease={fixVersion}&limit={limit}
Returns a list of representation of the issues for the given fixVersion.

Get testing info for issues by fixVersion

Type: GET
Url: /api/release/infoByRelease?jiraProject={jiraProject}&jiraRelease={fixVersion}&releaseNumber={releaseNumber}&limit={limit}
Returns test cases and deploy instructions of the issues for the given fixVersion.

Get release report by jiraRelease

Type: GET
Url: /release/getReleaseNote?jiraProject={jiraProject}&jiraRelease={fixVersion}&releaseNumber={releaseNumber}&limit={limit}
Returns release report data for the given fixVersion.

Get release report by jiraRelease in Confluence markdown

Type: GET
Url: /release/getReleaseNoteString?jiraProject={jiraProject}&jiraRelease={fixVersion}&releaseNumber={releaseNumber}&limit={limit}
Returns release report data for the given fixVersion.

Thanks!

Any questions or problems give me a shout on email [email protected]

License

Copyright 2020 Anton Klimakov
Licensed under the Apache License, Version 2.0