jira-sprinter 2.0.1 → 2.1.0
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/README.md +59 -1
- package/dist/main.js +10913 -8195
- package/package.json +14 -14
- package/src/auto.ts +94 -0
- package/src/cli.ts +39 -69
- package/src/jira.ts +110 -4
- package/src/util.ts +2 -1
- package/systemd/jira-sprinter.service +8 -0
- package/systemd/jira-sprinter.timer +10 -0
package/README.md
CHANGED
|
@@ -61,7 +61,7 @@ jira-sprinter
|
|
|
61
61
|
|
|
62
62
|
```md
|
|
63
63
|
$ jira-sprinter --help
|
|
64
|
-
Usage: jira-sprinter [options]
|
|
64
|
+
Usage: jira-sprinter [options] [command]
|
|
65
65
|
|
|
66
66
|
🏃 Small CLI tool to manage sprints in JIRA Board
|
|
67
67
|
|
|
@@ -74,4 +74,62 @@ Options:
|
|
|
74
74
|
-n, --nocolor Disable color output (default: false)
|
|
75
75
|
-x, --dry dry run
|
|
76
76
|
-h, --help display help for command
|
|
77
|
+
|
|
78
|
+
Commands:
|
|
79
|
+
auto [options] Automatically manages split tasks (DEV and
|
|
80
|
+
Preliminary Testing) based on ticket state and
|
|
81
|
+
status
|
|
77
82
|
```
|
|
83
|
+
|
|
84
|
+
### `auto` command
|
|
85
|
+
|
|
86
|
+
The `auto` command automates the creation of Preliminary Testing split tasks. It scans the board for issues where Preliminary Testing is marked as "Requested" and creates the corresponding split task if one does not already exist (or was previously closed).
|
|
87
|
+
|
|
88
|
+
```md
|
|
89
|
+
$ jira-sprinter auto --help
|
|
90
|
+
Usage: jira-sprinter auto [options]
|
|
91
|
+
|
|
92
|
+
Automatically manages split tasks (DEV and Preliminary Testing) based on ticket
|
|
93
|
+
state and status
|
|
94
|
+
|
|
95
|
+
Options:
|
|
96
|
+
-b, --board [board] Jira Board ID
|
|
97
|
+
-t, --team [assigned team] Jira Assigned Team
|
|
98
|
+
-c, --components [components] Jira Components
|
|
99
|
+
-h, --help display help for command
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
## Systemd Timer
|
|
103
|
+
|
|
104
|
+
You can run the `auto` command on a schedule using the provided systemd units in `systemd/`.
|
|
105
|
+
|
|
106
|
+
### Setup
|
|
107
|
+
|
|
108
|
+
1. Edit `systemd/jira-sprinter.service` and set the correct paths:
|
|
109
|
+
|
|
110
|
+
- `EnvironmentFile=` -- path to the `.env` file containing `JIRA_API_TOKEN`
|
|
111
|
+
- `ExecStart=` -- path to the `jira-sprinter` command with the required arguments
|
|
112
|
+
|
|
113
|
+
2. Copy the units to your user systemd directory:
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
mkdir -p ~/.config/systemd/user
|
|
117
|
+
cp systemd/jira-sprinter.service ~/.config/systemd/user/
|
|
118
|
+
cp systemd/jira-sprinter.timer ~/.config/systemd/user/
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
3. Reload systemd, enable and start the timer:
|
|
122
|
+
|
|
123
|
+
```bash
|
|
124
|
+
systemctl --user daemon-reload
|
|
125
|
+
systemctl --user enable --now jira-sprinter.timer
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
4. Verify the timer is active:
|
|
129
|
+
|
|
130
|
+
```bash
|
|
131
|
+
systemctl --user status jira-sprinter.timer
|
|
132
|
+
systemctl --user list-timers
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
The timer fires every 20 minutes (at :00, :20, and :40). The service uses `Type=oneshot`, so systemd will never start a second instance if a previous run is still in progress.
|