jira-sprinter 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +674 -0
- package/README.md +75 -0
- package/dist/main.js +49516 -0
- package/package.json +55 -0
- package/src/cli.ts +233 -0
- package/src/jira.ts +179 -0
- package/src/logger.ts +14 -0
- package/src/main.ts +24 -0
- package/src/schema/jira.ts +107 -0
- package/src/util.ts +49 -0
package/README.md
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# JIRA Sprinter
|
|
2
|
+
|
|
3
|
+
[![npm version][npm-status]][npm] [![Tests][test-status]][test] [![Linters][lint-status]][lint] [![CodeQL][codeql-status]][codeql] [![codecov][codecov-status]][codecov]
|
|
4
|
+
|
|
5
|
+
[npm]: https://www.npmjs.com/package/sprinter
|
|
6
|
+
[npm-status]: https://img.shields.io/npm/v/sprinter
|
|
7
|
+
|
|
8
|
+
[test]: https://github.com/redhat-plumbers-in-action/sprinter/actions/workflows/tests.yml
|
|
9
|
+
[test-status]: https://github.com/redhat-plumbers-in-action/sprinter/actions/workflows/tests.yml/badge.svg
|
|
10
|
+
|
|
11
|
+
[lint]: https://github.com/redhat-plumbers-in-action/sprinter/actions/workflows/lint.yml
|
|
12
|
+
[lint-status]: https://github.com/redhat-plumbers-in-action/sprinter/actions/workflows/lint.yml/badge.svg
|
|
13
|
+
|
|
14
|
+
[codeql]: https://github.com/redhat-plumbers-in-action/sprinter/actions/workflows/codeql-analysis.yml
|
|
15
|
+
[codeql-status]: https://github.com/redhat-plumbers-in-action/sprinter/actions/workflows/codeql-analysis.yml/badge.svg
|
|
16
|
+
|
|
17
|
+
[codecov]: https://codecov.io/gh/redhat-plumbers-in-action/sprinter
|
|
18
|
+
[codecov-status]: https://codecov.io/gh/redhat-plumbers-in-action/sprinter/graph/badge.svg?token=79yXVIeHyn
|
|
19
|
+
|
|
20
|
+
<!-- -->
|
|
21
|
+
|
|
22
|
+
## Description
|
|
23
|
+
|
|
24
|
+
Simple CLI tool that helps to manage sprints in JIRA Board.
|
|
25
|
+
|
|
26
|
+
## Usage
|
|
27
|
+
|
|
28
|
+
Make sure to store your JIRA Personal Access Token (PAT) in the `~/.config/jira-sprinter/.env` or `~/.env.jira-sprinter` file:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
# ~/.config/jira-sprinter/.env
|
|
32
|
+
JIRA_API_TOKEN="exaple-token"
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
> [!TIP]
|
|
36
|
+
>
|
|
37
|
+
> You can also set default values for the `assignee`, `board` in the `~/.config/jira-sprinter/.env` or `~/.env.jira-sprinter` file:
|
|
38
|
+
>
|
|
39
|
+
> ```bash
|
|
40
|
+
> # ~/.config/jira-sprinter/.env
|
|
41
|
+
> ASSIGNEE="your-jira-username"
|
|
42
|
+
> BOARD="your-jira-board-id"
|
|
43
|
+
> ```
|
|
44
|
+
|
|
45
|
+
### Using Node.js
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
# run it using npx
|
|
49
|
+
npx jira-sprinter
|
|
50
|
+
|
|
51
|
+
# or install it globally using npm
|
|
52
|
+
npm install -g jira-sprinter
|
|
53
|
+
jira-sprinter
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## How to use
|
|
57
|
+
|
|
58
|
+
> [!IMPORTANT]
|
|
59
|
+
>
|
|
60
|
+
> This tool is intended to be used by Red Hat employees on the Red Hat JIRA instance. It may be adapted to work with other JIRA instances in the future.
|
|
61
|
+
|
|
62
|
+
```md
|
|
63
|
+
$ jira-sprinter --help
|
|
64
|
+
Usage: jira-sprinter [options]
|
|
65
|
+
|
|
66
|
+
🏃 Small CLI tool to manage sprints in JIRA Board
|
|
67
|
+
|
|
68
|
+
Options:
|
|
69
|
+
-V, --version output the version number
|
|
70
|
+
-b, --board [board] Jira Board ID
|
|
71
|
+
-a, --assignee [assignee] Jira Assignee (default: "<user-login>@redhat.com")
|
|
72
|
+
-n, --nocolor Disable color output (default: false)
|
|
73
|
+
-x, --dry dry run
|
|
74
|
+
-h, --help display help for command
|
|
75
|
+
```
|