Jira Month Report

A utility for generating monthly reports from Jira worklogs. Creates Excel reports on completed tasks and reports with Story Points data.

Installation

# Global installation
npm install -g jira-month-report

# Local installation
npm install jira-month-report

Usage

As a CLI utility

1. Create a credentials file (e.g., credentials.env):

JIRA_USERNAME=your.username
PASSWORD=your_password
JIRA_STORYPOINTS_FIELD=customfield_12506  # optional, for SP reports

2. Run the utility:

# If installed globally
jira-month-report ./path/to/your.env

# If installed locally
npx jira-month-report ./path/to/your.env

The report will be saved in the reports folder in the current directory.

As a library

// JavaScript
const { generateReport } = require('jira-month-report');

// TypeScript
import { generateReport } from 'jira-month-report';

// Load environment variables beforehand
process.env.JIRA_USERNAME = 'your.username';
process.env.PASSWORD = 'your_password';

// Generate report
generateReport()
  .then(result => {
    console.log(`Report saved: ${result.reportPath}`);
    console.log(`Number of issues: ${result.issuesCount}`);
  })
  .catch(error => console.error('Error:', error));

Report Types

Excel Worklog Report

By default, an Excel report with work time details for the current month is generated.

Story Points Report

To generate a Story Points report, use the story.ts module (under development).

Development

# Clone the repository
git clone <repository-url>
cd jira-month-report

# Install dependencies
npm install

# Build the project
npm run build

# Run
npm start

License

ISC