https://github.com/gastaldi/jira-nag

https://github.com/gastaldi/jira-nag

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/gastaldi/jira-nag
• Owner: gastaldi
• Created: 2022-10-05T01:12:40.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-05T15:49:41.000Z (over 2 years ago)
• Last Synced: 2024-11-08T09:47:36.896Z (about 2 months ago)
• Language: Java
• Homepage:
• Size: 32.2 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Jira Nag

A CLI application that will nag your developers about their Jira tickets.

## Setup

1. Generate a Personal Access Token in JIRA (https://issues.redhat.com/secure/ViewProfile.jspa?selectedTab=com.atlassian.pats.pats-plugin:jira-user-personal-access-tokens)

2. Create an `.env` file in the root of this project with the following variables:

```dotenv

APP_JIRA_TOKEN=your-jira-token

```

## Running the application in dev mode

You can run your application in dev mode that enables live coding using:

```shell script

./mvnw clean compile quarkus:dev

```

## Creating a new profile

A profile is a JIRA Query mapped to an email template.

To create a new profile:

1. Create the Qute template in the `emails/` directory. (eg. `reviewIssues.html`)

2. Include the JIRA query in the application.properties file.

```properties

app.profiles.reviewIssues=project = Quarkus AND fixVersion = 2.13-Fireball.GA AND status in ("To Do", "Analysis in Progress", "Ready For Dev") AND component in ("team/eng") AND assignee is not EMPTY ORDER BY key ASC

```

3. Run the application using the `app.profile` that is set to the name of the query (eg. `-Dapp.profile=reviewIssues`)

## Running the application

You can set the `app.profile` value before running the application to use a specific profile (must exist in `application.properties`).

```shell script

```bash

APP_PROFILE=reviewIssues ./run.sh

```