Git Product home page Git Product logo

hack-jira-cfd's Introduction

GitHub Actions CI Status

hack-jira-cfd

Get more info about the flow of work in a Jira Cloud project.

Three graphs. The first one showing a histogram of tickets' cycle times. The second one showing the percentage of issues completed after x days. The third showing the Cumulative Flow Diagram with gaps for Saturdays and Sundays, the mouse pointing to Nov 9 2023 revealing the counts for "To Do" (5), "In Progress" (6) and "Resolved" (26)

Features and Known Non-Features

✅ Fetch a collection of issues based on some JQL (filter) query
❌ Handle limitations on the number of issues (check for pagination or similar)
✅ Authentication configured via environment variables (or .env)
✅ Query configured via env vars as well
✅ Fetch changelog of issues
✅ Determine date of issue going into "In Progress"
✅ "In Progress" state configured via env vars (currently hard coded as "In Progress")
❌ Deal with issues that were moved in and out of "In Progress" multiple times
✅ Calculate data for a cycle time histogram (# of days between going into "In Progress" and the issue's resolutionDate)
✅ Ignore issues that never went into "In Progress" ✅ Display the histogram, show the user
✅ Calculate data for a cycle time graph showing what percentage of all issues was completed in what period of time
✅ Display the cycle time percentages graph
✅ Calculate data for a Cumulative Flow Diagram (CFD)
✅ Display a Cumulative Flow Diagram
✅ Configure states for CFD via env vars
✅ Remove weekends from CFD

Running / Dev

Configuring via Environment Variables

We need a couple of environment variables set. You can use a .env file to do so.

Auth / API:

  • ATLASSIAN_USER_EMAIL - The email of the account to authenticate with
  • ATLASSIAN_API_TOKEN - An API token of the account to authenticate with (here's how to create: Atlassian docs)
  • JIRA_API_BASE_URL - The base URL of the Jira instance you want to talk to (e.g. https://<myCompany>.atlassian.net/rest/api/2)

Queries:

  • JIRA_JQL_QUERY_CYCLE_TIMES - The query to fetch issues to report cycle times on (e.g. project = MYPROJ AND status = Done AND created >= -30d)
  • JIRA_JQL_QUERY_CFD - The query to fetch issues to run the Cumulative Flow Diagram (CFD) on (e.g. project = MYPROJ)

States:

  • TODO_STATE_STRING - The state that depicts "To Do" (e.g. To Do)
  • IN_PROGRESS_STATE_STRING- The state that depicts "In Progress" (e.g. In Progress)

Running the App

  • Fetch dependencies: bun install
  • Run once: bun index.ts
  • Run in watch mode: bun --watch index.ts

Testing

  • Run tests once: bun test
  • Run in watch mode: bun --watch test

Contributing

Cf. Contributing.md

hack-jira-cfd's People

Contributors

hannes-mk avatar renovate[bot] avatar dependabot[bot] avatar

Stargazers

Ramakant Gadhewal avatar  avatar

Watchers

Julian avatar Kai Bernhard avatar  avatar

hack-jira-cfd's Issues

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Location: renovate.json
Error type: The renovate configuration file contains some invalid settings
Message: Invalid packageRules[0].schedule: Invalid schedule: Failed to parse "[every weekday]"

We need separate queries for cycle time graphs and the CFD

Cycle time graphs require the query to fetch only resolved issues. This, however, leads to the CFD reporting wrongly on the numbers of earlier states:
image

On the other hand, if removing the restriction to resolved issues, the CFD is fine while the cycle times graphs are broken:
image

This could be resolved by allowing for two independent queries.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

  • Lock file maintenance

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

github-actions
.github/workflows/bun.yml
  • actions/checkout v4
  • oven-sh/setup-bun v1
nodenv
.node-version
  • node 20.12.2
npm
package.json
  • date-fns 3.6.0
  • lodash 4.17.21
  • mathjs 12.4.1
  • nodeplotlib 1.1.2
  • @types/date-fns 2.6.0
  • @types/lodash 4.17.0
  • @types/mathjs 9.4.2
  • oxlint 0.2.17
  • typescript 5.4.5

  • Check this box to trigger a request for Renovate to run again on this repository

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.