Skip to content

Commit

Permalink
Explain the new JQL variables
Browse files Browse the repository at this point in the history
  • Loading branch information
hannes-mk committed Nov 30, 2023
1 parent 2376589 commit 24a0897
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,21 +27,22 @@ Get more info about the flow of work in a Jira Cloud project.

# Running / Dev

## Configure via Environment Variables
## Configuring via Environment Variables
We need a couple of environment variables set. You can use a `.env` file to do so.
* `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](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/))
* `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`)
* `JIRA_JQL_QUERY` - The query to fetch issues to report on (e.g. `project = MYPROJ AND status = Done AND created >= -30d order by created DESC`)
## Run the App
* `JIRA_JQL_QUERY_CYCLE_TIMES` - The query to fetch issues to report 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`)

## Running the App
* Fetch dependencies: `bun install`
* Run once: `bun index.ts`
* Run in watch mode: `bun --watch index.ts`

## Test
## Testing
* Run tests once: `bun test`
* Run in watch mode: `bun --watch test`


# Contributing
Cf. [`Contributing.md`](./Contributing.md)

0 comments on commit 24a0897

Please sign in to comment.