https://github.com/rojanthomas/danger-kotlin-jira

https://github.com/rojanthomas/danger-kotlin-jira

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/rojanthomas/danger-kotlin-jira
• Owner: rojanthomas
• License: mit
• Created: 2021-06-10T11:21:50.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2021-07-22T09:51:10.000Z (almost 3 years ago)
• Last Synced: 2024-01-14T19:51:59.379Z (5 months ago)
• Language: Kotlin
• Size: 112 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-danger - danger-kotlin-jira - Collect and display mentioned JIRA issues as a hyperlinked Danger message (Plugins / Kotlin (danger-kotlin))

README

        
# danger-kotlin-jira

![Maven Central](https://img.shields.io/maven-central/v/com.rojanthomas/danger-kotlin-jira)

![example workflow](https://github.com/rojanthomas/danger-kotlin-jira/actions/workflows/pr_danger.yml/badge.svg)

![example workflow](https://github.com/rojanthomas/danger-kotlin-jira/actions/workflows/pr_tests.yml/badge.svg)

![example workflow](https://github.com/rojanthomas/danger-kotlin-jira/actions/workflows/publish.yml/badge.svg)

![GitHub](https://img.shields.io/github/license/rojanthomas/danger-kotlin-jira)

This plugin will collect JIRA issues mentioned in a PR (e.g. ROJ-1234) and display them as a hyperlinked Danger message.

![Screenshot](./images/danger_message.png)

## Getting started

1. Add the following dependency at the top of your kts Dangerfile

```kotlin

@file:DependsOn("com.rojanthomas:danger-kotlin-jira:x.y.z")

```

2. Register the plugin in your kts Dangerfile (this must be after the dependency declaration).

```kotlin

register plugin JiraPlugin

```

3. Invoke JiraPlugin.check(...), passing in the `jiraUrl`, which `projectKeys` to look for & which `sources` to check `projectKeys` for. You can provide any number of `projectKeys` or `sources`.

```kotlin

danger(args) {

    JiraPlugin.check(

        jiraUrl = "https://rojanthomas.atlassian.net/browse/",

        projectKeys = listOf("ROJ", "THO"),

        sources = listOf(

            this.github.pullRequest.title,

            this.github.pullRequest.body,

        )

    )

}

```