jira-daily-report 0.1.109 → 0.1.110
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 +67 -18
- package/dist/cli/index.js +73 -57
- package/dist/cli/index.js.map +3 -3
- package/dist/extension.js +25 -25
- package/dist/extension.js.map +3 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,47 +1,96 @@
|
|
|
1
|
-
|
|
1
|
+
## Jira Daily Report
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
### Features
|
|
4
4
|
|
|
5
|
+
- Report Generation
|
|
6
|
+
- Time Logging
|
|
7
|
+
---
|
|
5
8
|
|
|
6
9
|
## Installation
|
|
7
10
|
|
|
8
|
-
### CLI Tool (
|
|
11
|
+
### CLI Tool (Global)
|
|
9
12
|
|
|
10
13
|
```bash
|
|
11
|
-
#
|
|
12
|
-
|
|
14
|
+
# Install globally using npm/pnpm/yarn
|
|
15
|
+
npm install -g jira-daily-report
|
|
13
16
|
```
|
|
14
17
|
|
|
18
|
+
### Environment Variables
|
|
15
19
|
|
|
16
|
-
|
|
17
|
-
- **Tempo API Token**: Get from https://your-domain.atlassian.net/plugins/servlet/ac/io.tempo.jira/tempo-app#!/configuration/api-integration
|
|
18
|
-
|
|
19
|
-
**Or use environment variables:**
|
|
20
|
+
Environment variables take precedence over config files:
|
|
20
21
|
|
|
21
22
|
```bash
|
|
22
23
|
# Add to your shell profile (.bashrc, .zshrc, .bash_profile)
|
|
23
|
-
|
|
24
24
|
export JIRA_SERVER="https://your-domain.atlassian.net/"
|
|
25
|
-
export JIRA_USERNAME="
|
|
25
|
+
export JIRA_USERNAME="your-email@example.com"
|
|
26
26
|
export JIRA_API_TOKEN="your-jira-api-token"
|
|
27
27
|
export TEMPO_API_TOKEN="your-tempo-api-token"
|
|
28
|
-
|
|
28
|
+
|
|
29
|
+
# Optional settings
|
|
30
|
+
export WHO_AM_I="Developer" #or "QC"
|
|
31
|
+
export AUTO_CLIPBOARD="true"
|
|
29
32
|
|
|
30
33
|
# Reload your shell configuration
|
|
31
34
|
source ~/.zshrc # or ~/.bashrc
|
|
32
35
|
```
|
|
33
36
|
|
|
34
|
-
###
|
|
37
|
+
### Get Your API Tokens
|
|
38
|
+
|
|
39
|
+
- **Jira API Token**: https://id.atlassian.com/manage-profile/security/api-tokens
|
|
40
|
+
- **Tempo API Token**: https://apidocs.tempo.io/#section/Authentication
|
|
41
|
+
- Go to: `https://your-domain.atlassian.net/plugins/servlet/ac/io.tempo.jira/tempo-app#!/configuration/api-integration`
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## CLI Commands
|
|
35
46
|
|
|
36
|
-
|
|
47
|
+
### 1. `jira-report generate`
|
|
37
48
|
|
|
38
49
|
|
|
39
|
-
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
### 2. `jira-report logtime`
|
|
53
|
+
|
|
54
|
+
Log time to Tempo for one or multiple tickets with flexible date support.
|
|
55
|
+
|
|
56
|
+
**Usage:**
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
# Log time for today (default)
|
|
60
|
+
jira-report logtime "B2B-1079 2h"
|
|
61
|
+
|
|
62
|
+
# Log multiple tickets at once
|
|
63
|
+
jira-report logtime "B2B-1079 2h, PROJECT-123 1.5h, TASK-456 30m"
|
|
40
64
|
|
|
41
|
-
|
|
42
|
-
-
|
|
65
|
+
# Log time for yesterday
|
|
66
|
+
jira-report logtime "B2B-1079 2h" --date yesterday
|
|
43
67
|
|
|
44
|
-
|
|
68
|
+
# Log time for a specific date
|
|
69
|
+
jira-report logtime "B2B-1079 2h" --date 2025-01-15
|
|
70
|
+
|
|
71
|
+
# Add description to all entries
|
|
72
|
+
jira-report logtime "B2B-1079 2h, PROJECT-123 1h" --description "Fixed authentication bug"
|
|
73
|
+
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
**Timesheet Format:**
|
|
77
|
+
|
|
78
|
+
The timesheet format supports flexible time notation:
|
|
79
|
+
|
|
80
|
+
- `2h` - 2 hours
|
|
81
|
+
- `1.5h` - 1 hour 30 minutes
|
|
82
|
+
- `30m` - 30 minutes
|
|
83
|
+
- `1h 30m` - 1 hour 30 minutes (combined)
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## Support
|
|
45
88
|
|
|
46
89
|
For help with setup, troubleshooting, or feature requests, please visit our [GitHub Issues](https://github.com/voxuanthuan/daily-report/issues) page.
|
|
47
90
|
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## License
|
|
94
|
+
|
|
95
|
+
MIT
|
|
96
|
+
|