-
Notifications
You must be signed in to change notification settings - Fork 66
/
git-issue.sh
executable file
·1545 lines (1379 loc) · 39.1 KB
/
git-issue.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/bin/sh
# shellcheck disable=SC2039,SC1117,SC2006
# TODO: SC2006 not needed on latest shellcheck version
# Shellcheck ignore list:
# - SC2039: In POSIX sh, 'local' is undefined.
# Rationale: Local makes for better code and works on many modern shells
# - SC1117: Backslash is literal. Prefer explicit escaping.
#
# (C) Copyright 2016-2020 Diomidis Spinellis
#
# This file is part of git-issue, the Git-based issue management system.
#
# git-issue is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# git-issue is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with git-issue. If not, see <http://www.gnu.org/licenses/>.
#
# User agent string
# shellcheck disable=SC2034
# SC2034 : USER_AGENT appears unused. Verify use (or export if used externally)
USER_AGENT=https://github.com/dspinellis/git-issue/tree/afda065
# Determine our script library path
my_IFS=$IFS
IFS=:
# Set library path
# shellcheck disable=SC2086
# Rationale: Word splitting not an issue
LIB_PATH="$(dirname $0)/lib:$(dirname $0)/../lib:$LD_LIBRARY_PATH:/usr/local/lib:/usr/lib"
if [ "x$GIT_ISSUE_LIB_PATH" != x ] ; then
LIB_PATH="$GIT_ISSUE_LIB_PATH"
fi
for i in ${LIB_PATH} ; do
if [ -d "${i}/git-issue" ] ; then
MY_LIB="${i}/git-issue"
break
fi
done
IFS=$my_IFS
if command -v gdate > /dev/null ; then
DATEBIN="gdate"
else
DATEBIN="date"
fi
# Exit after displaying the specified error
error()
{
echo "$1" 1>&2
exit 1
}
$DATEBIN --help | grep 'gnu' > /dev/null || error "Require GNU date"
test "x$MY_LIB" != x || error "No git-issue directory in path $LIB_PATH"
# Return a unique identifier for the specified file
filesysid()
{
stat --printf='%d:%i' "$1" 2>/dev/null ||
stat -f '%d:%i' "$1"
}
# Move to the .issues directory
cdissues()
{
while : ; do
cd .issues 2>/dev/null && return
if [ "$(filesysid .)" = "$(filesysid /)" ] ; then
error 'Not an issues repository (or any of the parent directories)'
fi
cd ..
done
}
# Output the path of an issue given its SHA
# The scheme used for storing the issues is a two level directory
# structure where the first level consists of the first two SHA
# letters
#
# issue_path_full <SHA>
issue_path_full()
{
local sha
sha="$1"
echo issues/"$(expr "$sha" : '\(..\)')/$(expr "$sha" : '..\(.*\)'$)"
}
# Output the path of an issue given its (possibly partial) SHA
# Abort with an error if the full path can not be uniquely resolved
# to an existing issue
# issue_path_part <SHA>
issue_path_part()
{
local sha partial path
sha="$1"
partial=$(issue_path_full "$sha")
path=$(echo "${partial}"*)
test -d "$path" || error "Unknown or ambigious issue specification $sha"
echo "$path"
}
# Given an issue path return its SHA
issue_sha()
{
echo "$1" | sed 's/issues\/\(..\)\/\([^/]*\).*/\1\2/'
}
# Shorten a full SHA
short_sha()
{
git rev-parse --short "$1"
}
# Start an issue transaction
trans_start()
{
cdissues
start_sha=$(git rev-parse HEAD)
}
# Abort an issue transaction and exit with an error
trans_abort()
{
if [ -d .git ] || git rev-parse --git-dir > /dev/null 2>&1 ; then
git reset "$start_sha"
git clean -qfd
git checkout -- .
rm -f issue-header issue-body comments-header comments-body create-body create-header update-body update-header
rm -f milestone-body milestone-header mileres-body mileres-header timestats-header
rm -f timeestimate-body timeestimate-header timespent-body timespent-header timestats-body
fi
echo 'Operation aborted' 1>&2
exit 1
}
# Exit with an error if the specified prerequisite command
# cannot be executed
prerequisite_command()
{
if ! $1 -help 2>/dev/null 1>&2 ; then
cat <<EOF 1>&2
The $1 command is not available through the configured path.
Please install it and/or configure your PATH variable.
Command aborted.
EOF
exit 1
fi
}
# Commit an issue's changes
# commit <summary> <message> [<date>]
commit()
{
commit_summary=$1
shift
commit_message=$1
shift
GIT_AUTHOR_DATE="$GIT_EVENT_DATE" GIT_COMMITTER_DATE="$GIT_EVENT_DATE" \
git commit --allow-empty -q -m "$commit_summary
$commit_message" "$@" || trans_abort
}
# Allow the user to edit the specified file
# Remove lines starting with '#'
# Succeed if at the resulting file is non-empty
edit()
{
local file
file="$1"
touch "$file"
cp "$file" "$file.new"
echo "Opening editor..."
${VISUAL:-vi} "$file.new" || return 1
grep -v '^#' "$file.new" >"$file.uncommented"
mv "$file.uncommented" "$file.new"
if ! test -s "$file.new" ; then
echo 'Empty file' 1>&2
rm -f "$file.new"
return 1
fi
if diff -q "$file" "$file.new" >/dev/null 2>&1; then
echo 'File was not changed' 1>&2
rm -f "$file.new"
return 1
fi
mv "$file.new" "$file"
}
# Pipe input through the user's pager
pager()
{
${PAGER:-more}
}
# init: Initialize a new issue repository {{{1
usage_init()
{
cat <<\USAGE_new_EOF
gi init usage: git issue init [-e]
-e Use existing project's Git repository
USAGE_new_EOF
exit 2
}
sub_init()
{
local existing username useremail
while getopts e flag ; do
case $flag in
e)
existing=1
;;
?)
usage_init
;;
esac
done
shift $((OPTIND - 1));
test -d .issues && error 'An .issues directory is already present'
mkdir .issues || error 'Unable to create .issues directory'
username=`git config --local user.name`
useremail=`git config --local user.email`
cdissues
if ! [ "$existing" ] ; then
git init -q || error 'Unable to initialize Git directory'
fi
# Editing templates
touch config || error 'Unable to create configuration file'
mkdir templates || error 'Unable to create the templates directory'
cat >templates/description <<\EOF
# Start with a one-line summary of the issue. Leave a blank line and
# continue with the issue's detailed description.
#
# Remember:
# - Be precise
# - Be clear: explain how to reproduce the problem, step by step,
# so others can reproduce the issue
# - Include only one problem per issue report
#
# Lines starting with '#' will be ignored, and an empty message aborts
# the issue addition.
EOF
cat >templates/comment <<\EOF
# Please write here a comment regarding the issue.
# Keep the conversation constructive and polite.
# Lines starting with '#' will be ignored, and an empty message aborts
# the issue addition.
EOF
cat >README.md <<\EOF
This is an distributed issue tracking repository based on Git.
Visit [git-issue](https://github.com/dspinellis/git-issue) for more information.
EOF
git add config README.md templates/comment templates/description
if [ -n "$username" ] ; then
git config --local user.name "$username"
fi
if [ -n "$useremail" ] ; then
git config --local user.email "$useremail"
fi
commit 'gi: Initialize issues repository' 'gi init'
echo "Initialized empty issues repository in $(pwd)"
}
# new: Open a new issue {{{1
usage_new()
{
cat <<\USAGE_new_EOF
gi new usage: git issue new [-s summary]
USAGE_new_EOF
exit 2
}
sub_new()
{
local summary sha path
while getopts s:c: flag ; do
case $flag in
s)
summary="$OPTARG"
;;
c)
create=$OPTARG
;;
?)
usage_new
;;
esac
done
shift $((OPTIND - 1));
trans_start
commit 'gi: Add issue' 'gi new mark'
sha=$(git rev-parse HEAD)
path=$(issue_path_full "$sha")
mkdir -p "$path" || trans_abort
echo open >"$path/tags" || trans_abort
if [ "$summary" ] ; then
echo "$summary" >"$path/description" || trans_abort
else
cp templates/description "$path/description" || trans_abort
edit "$path/description" || trans_abort
fi
git add "$path/description" "$path/tags" || trans_abort
commit 'gi: Add issue description' "gi new description $sha"
echo "Added issue $(short_sha "$sha")"
# export issue immediately
if [ -n "$create" ] ; then
# shellcheck disable=SC2086
# Rationale: We want word splitting
create_issue -n "$sha" $create
fi
}
# show: Show the specified issue {{{1
usage_show()
{
cat <<\USAGE_show_EOF
gi show usage: git issue show [-c] <sha>
-c Show comments
USAGE_show_EOF
exit 2
}
sub_show()
{
local isha path comments rawdate rawest rawspent OPTIND
while getopts c flag ; do
case $flag in
c)
comments=1
;;
?)
usage_show
;;
esac
done
shift $((OPTIND - 1));
test -n "$1" || usage_show
cdissues
path=$(issue_path_part "$1") || exit
isha=$(issue_sha "$path")
{
# SHA, author, date
echo "issue $isha"
git show --no-patch --format='Author: %an <%ae>
Date: %aD' "$isha"
# Imports
for i in $(importsget "$isha") ; do
local num
num=$(echo "$i" | grep -o '/[0-9]\+$' | tr -d '/')
if echo "$i" | grep -q '^github' ; then
echo "GitHub issue: #$num at $i" | sed -e 's:/[0-9]\+$::' -e 's:github/::'
else
echo "GitLab issue: #$num at $i" | sed -e 's:/[0-9]\+$::' -e 's:gitlab/::'
fi
done
# Due Date
if [ -s "$path/duedate" ] ; then
printf 'Due Date: '
# Print date in rfc-3339 for consistency with git show
rawdate=$(cat "$path/duedate")
$DATEBIN --date="$rawdate" --rfc-3339=seconds
fi
# Time estimate
if [ -s "$path/timeestimate" ] && [ -s "$path/timespent" ] ; then
printf 'Time Spent/Time Estimated: '
rawest=$(cat "$path/timeestimate")
rawspent=$(cat "$path/timespent")
# shellcheck disable=SC2016
# SC2016: Expressions don't expand is single quotes, use double quotes for that
# Rationale: We don't want expansion
eval "echo $($DATEBIN --utc --date="@$rawspent" +'$((%s/3600/24)) days %H hours %M minutes %S seconds')" |
# Remove newline and trim unnecessary fields
tr -d '\n' | sed -e "s/00 \(hours\|minutes\|seconds\) \?//g" -e "s/^0 days //"
printf '/ '
# shellcheck disable=SC2016
eval "echo $($DATEBIN --utc --date="@$rawest" +'$((%s/3600/24)) days %H hours %M minutes %S seconds')" |
sed -e "s/00 \(hours\|minutes\|seconds\) \?//g" -e "s/^0 days //"
elif [ -s "$path/timespent" ] ; then
printf 'Time Spent: '
# Print time in human readable format
rawspent=$(cat "$path/timespent")
# shellcheck disable=SC2016
eval "echo $($DATEBIN --utc --date="@$rawspent" +'$((%s/3600/24)) days %H hours %M minutes %S seconds')" |
sed -e "s/00 \(hours\|minutes\|seconds\) \?//g" -e "s/^0 days //"
elif [ -s "$path/timeestimate" ] ; then
printf 'Time Estimate: '
# Print time in human readable format
rawest=$(cat "$path/timeestimate")
# shellcheck disable=SC2016
eval "echo $($DATEBIN --utc --date="@$rawest" +'$((%s/3600/24)) days %H hours %M minutes %S seconds')" |
sed -e "s/00 \(hours\|minutes\|seconds\) \?//g" -e "s/^0 days //"
fi
# Milestone
if [ -s "$path/milestone" ] ; then
printf 'Milestone: '
cat "$path/milestone"
fi
# Weight
if [ -s "$path/weight" ] ; then
printf 'Weight: '
cat "$path/weight"
fi
# Tags
if [ -s "$path/tags" ] ; then
printf 'Tags:'
sed 's/^/ /' "$path/tags"
fi
# Watchers
if [ -s "$path/watchers" ] ; then
printf 'Watchers:'
fmt "$path/watchers" | sed 's/^/ /'
fi
# Assignee
if [ -r "$path/assignee" ] ; then
printf 'Assigned-to:'
sed 's/^/ /' "$path/assignee"
fi
# Description
echo
sed 's/^/ /' "$path/description"
# Edit History
echo
printf '%s\n' 'Edit History:'
git log --reverse --format="%aD by %an <%ae>" "$path/description" | fmt | sed 's/^/* /'
# Comments
test -n "$comments" || return
git log --reverse --grep="^gi comment mark $isha" --format='%H' |
while read -r csha ; do
echo
echo "comment $csha"
git show --no-patch --format='Author: %an <%ae>
Date: %aD
' "$csha"
sed 's/^/ /' "$path/comments/$csha"
done
} | pager
}
# clone: Clone the specified remote repository {{{1
usage_clone()
{
cat <<\USAGE_clone_EOF
gi clone usage: git issue clone <URL> <local-dir>
USAGE_clone_EOF
exit 2
}
sub_clone()
{
test -n "$1" -a -n "$2" || usage_clone
mkdir -p "$2" || error "Unable to create local directory"
cd "$2" || error "Unable to change into local directory"
git clone "$1" .issues
echo "Cloned $1 into $2"
}
# milestone: set an issue's milestone {{{1
usage_milestone()
{
cat <<\USAGE_tag_EOF
gi milestone usage: git issue milestone <sha> <milestone>
git issue milestone -r <sha>
-r Remove the issue's milestone
USAGE_tag_EOF
exit 2
}
sub_milestone()
{
local isha tag remove path milestone OPTIND
while getopts r flag ; do
case $flag in
r)
remove=1
;;
?)
usage_milestone
;;
esac
done
shift $((OPTIND - 1));
test -n "$1" -a -n "$2$remove" || usage_milestone
test -n "$remove" -a -n "$2" && usage_milestone
milestone="$2"
cdissues
path=$(issue_path_part "$1") || exit
shift
isha=$(issue_sha "$path")
if [ "$remove" ] ; then
test -r "$path/milestone" || error "No milestone set"
milestone=$(cat "$path/milestone")
trans_start
git rm "$path/milestone" >/dev/null || trans_abort
commit "gi: Remove milestone" "gi milestone remove $milestone"
echo "Removed milestone $milestone"
else
touch "$path/milestone" || error "Unable to modify milestone file"
printf '%s\n' "$milestone" >"$path/milestone"
trans_start
git add "$path/milestone" || trans_abort
commit "gi: Add milestone" "gi milestone add $milestone"
echo "Added milestone $milestone"
fi
}
# weight: set an issue's weight {{{1
usage_weight()
{
cat <<\USAGE_tag_EOF
gi weight usage: git issue weight <sha> <weight>
git issue weight -r <sha>
-r Remove the issue's weight
USAGE_tag_EOF
exit 2
}
sub_weight()
{
local isha tag remove path weight OPTIND
while getopts r flag ; do
case $flag in
r)
remove=1
;;
?)
usage_weight
;;
esac
done
shift $((OPTIND - 1));
test -n "$1" -a -n "$2$remove" || usage_weight
test -n "$remove" -a -n "$2" && usage_weight
weight="$2"
if ! [ "$remove" ] ; then
# weight is positive integer
expr "$weight" : '[0-9]*$' > /dev/null || usage_weight
fi
cdissues
path=$(issue_path_part "$1") || exit
shift
isha=$(issue_sha "$path")
if [ "$remove" ] ; then
test -r "$path/weight" || error "No weight set"
weight=$(cat "$path/weight")
trans_start
git rm "$path/weight" >/dev/null || trans_abort
commit "gi: Remove weight" "gi weight remove $weight"
echo "Removed weight $weight"
else
touch "$path/weight" || error "Unable to modify weight file"
printf '%s\n' "$weight" >"$path/weight"
trans_start
git add "$path/weight" || trans_abort
commit "gi: Add weight" "gi weight add $weight"
echo "Added weight $weight"
fi
}
# duedate: set an issue's weight {{{1
usage_duedate()
{
cat <<\USAGE_tag_EOF
gi duedate usage: git issue duedate <sha> <dd>
git issue duedate -r <sha>
<dd> date in format accepted by `date`
-r Remove the issue's duedate
USAGE_tag_EOF
exit 2
}
sub_duedate()
{
local isha tag remove path duedate OPTIND
while getopts r flag ; do
case $flag in
r)
remove=1
;;
?)
usage_duedate
;;
esac
done
shift $((OPTIND - 1));
test -n "$1" -a -n "$2$remove" || usage_duedate
test -n "$remove" -a -n "$2" && usage_duedate
# Date is stored in the ISO-8601 format
duedate=$($DATEBIN --date="$2" --iso-8601=seconds) || usage_duedate
if ! [ "$remove" ] ; then
# Convert dates to utc for accurate comparison
expr "$($DATEBIN --date="$duedate" --iso-8601=seconds --utc)" '>' "$($DATEBIN --date='now' --iso-8601=seconds --utc)" \
> /dev/null || printf "Warning: duedate is in the past\n"
fi
cdissues
path=$(issue_path_part "$1") || exit
shift
isha=$(issue_sha "$path")
if [ "$remove" ] ; then
test -r "$path/duedate" || error "No duedate set"
duedate=$(cat "$path/duedate")
trans_start
git rm "$path/duedate" >/dev/null || trans_abort
commit "gi: Remove duedate" "gi duedate remove $duedate"
echo "Removed duedate $duedate"
else
touch "$path/duedate" || error "Unable to modify duedate file"
printf '%s\n' "$duedate" >"$path/duedate"
trans_start
git add "$path/duedate" || trans_abort
commit "gi: Add duedate" "gi duedate add $duedate"
echo "Added duedate $duedate"
fi
}
# timespent: set time spent on an issue {{{1
usage_timespent()
{
cat <<\USAGE_tag_EOF
gi timespent usage: git issue timespent [-a] <sha> <ts>
-a instead of replacing the time spent, add to it
git issue timespent -r <sha>
<ts> time interval in format accepted by `date`
-r Remove the issue's timespent
USAGE_tag_EOF
exit 2
}
sub_timespent()
{
local isha tag remove path timespent add OPTIND
while getopts ra flag ; do
case $flag in
a)
add=1
;;
r)
remove=1
;;
?)
usage_timespent
;;
esac
done
shift $((OPTIND - 1));
test -n "$1" -a -n "$2$remove" || usage_timespent
test -n "$remove" -a -n "$add" && usage_timespent
test -n "$remove" -a -n "$2" && usage_timespent
# Timespent is stored in seconds
timespent=$($DATEBIN --date="1970-1-1 +$2" --utc +%s)|| usage_timespent
if ! [ "$remove" ] ; then
# Check for negative time interval
if [ "$timespent" -lt 0 ] ; then
usage_timespent
fi
fi
cdissues
path=$(issue_path_part "$1") || exit
shift
isha=$(issue_sha "$path")
if [ "$remove" ] ; then
test -r "$path/timespent" || error "No time spent set"
timespent=$(cat "$path/timespent")
trans_start
git rm "$path/timespent" >/dev/null || trans_abort
commit "gi: Remove timespent" "gi timespent remove $timespent"
echo "Removed timespent $timespent"
else
if [ "$add" ] ; then
test -r "$path/timespent" || error "No time spent set"
rawspent=$(cat "$path/timespent")
# Add the existing time spent
timespent=$((rawspent + timespent))
fi
touch "$path/timespent" || error "Unable to modify timespent file"
printf '%s\n' "$timespent" >"$path/timespent"
trans_start
git add "$path/timespent" || trans_abort
commit "gi: Add timespent" "gi timespent add $timespent"
echo "Added timespent $timespent"
fi
}
# timeestimate: set time spent on an issue {{{1
usage_timeestimate()
{
cat <<\USAGE_tag_EOF
gi timeestimate usage: git issue timeestimate <sha> <te>
git issue timeestimate -r <sha>
<te> time interval in format accepted by `date`
-r Remove the issue's time estimate
USAGE_tag_EOF
exit 2
}
sub_timeestimate()
{
local isha tag remove path timeestimate rawspent OPTIND
while getopts r flag ; do
case $flag in
r)
remove=1
;;
?)
usage_timeestimate
;;
esac
done
shift $((OPTIND - 1));
test -n "$1" -a -n "$2$remove" || usage_timeestimate
test -n "$remove" -a -n "$2" && usage_timeestimate
# Timeestimate is stored in seconds
timeestimate=$($DATEBIN --date="1970-1-1 +$2" --utc +%s)|| usage_timeestimate
if ! [ "$remove" ] ; then
# Check for negative time interval
if [ "$timeestimate" -lt 0 ] ; then
usage_timespent
fi
fi
cdissues
path=$(issue_path_part "$1") || exit
shift
isha=$(issue_sha "$path")
if [ "$remove" ] ; then
test -r "$path/timeestimate" || error "No time estimate set"
timeestimate=$(cat "$path/timeestimate")
trans_start
git rm "$path/timeestimate" >/dev/null || trans_abort
commit "gi: Remove timeestimate" "gi timeestimate remove $timeestimate"
echo "Removed timeestimate $timeestimate"
else
touch "$path/timeestimate" || error "Unable to modify timeestimate file"
printf '%s\n' "$timeestimate" >"$path/timeestimate"
trans_start
git add "$path/timeestimate" || trans_abort
commit "gi: Add timeestimate" "gi timeestimate add $timeestimate"
echo "Added timeestimate $timeestimate"
fi
}
# assign: assign an issue to a person or remove assignment {{{1
usage_assignee()
{
cat <<\USAGE_tag_EOF
gi assign usage: git issue assign [-r] <sha> <email> ...
-r Remove the specified assignee
USAGE_tag_EOF
exit 2
}
sub_assign()
{
file_add_rm assignee assignee "$@"
}
# Generic file add/remove entry {{{1
# file_add_rm [-r] entry-name filename sha entry ...
file_add_rm()
{
local usage name file isha tag remove path OPTIND
name=$1
shift
file=$1
shift
usage=usage_$name
while getopts r flag ; do
case $flag in
r)
remove=1
;;
?)
$usage
;;
esac
done
shift $((OPTIND - 1));
test -n "$1" -a -n "$2" || $usage
cdissues
path=$(issue_path_part "$1") || exit
shift
isha=$(issue_sha "$path")
touch "$path/$file" || error "Unable to modify $file file"
for entry in "$@" ; do
if [ "$remove" ] ; then
grep -Fvx "$entry" "$path/$file" >"$path/$file.new"
if cmp "$path/$file" "$path/$file.new" >/dev/null 2>&1 ; then
echo "No such $name entry: $entry" 1>&2
rm "$path/$file.new"
exit 1
fi
mv "$path/$file.new" "$path/$file"
trans_start
git add "$path/$file" || trans_abort
echo "Removed $name $entry"
if ! [ -s "$path/$file" ] ; then
git rm -f "$path/$file" >/dev/null || trans_abort
fi
commit "gi: Remove $name" "gi $name remove $entry"
else
if grep -Fx "$entry" "$path/$file" >/dev/null ; then
echo "Entry $entry already exists" 1>&2
exit 1
fi
# Add entry in sorted order to avoid gratuitous updates when importing
printf '%s\n' "$entry" |
LC_ALL=C sort -m - "$path/$file" >"$path/$file.new"
mv "$path/$file.new" "$path/$file"
trans_start
git add "$path/$file" || trans_abort
commit "gi: Add $name" "gi $name add $entry"
echo "Added $name $entry"
fi
done
}
# tag: Add or remove an issue tag {{{1
usage_tag()
{
cat <<\USAGE_tag_EOF
gi tag usage: git issue tag [-r] <sha> <tag> ...
-r Remove the specified tag
USAGE_tag_EOF
exit 2
}
sub_tag()
{
file_add_rm tag tags "$@"
}
# watcher: Add or remove an issue watcher {{{1
usage_watcher()
{
cat <<\USAGE_watcher_EOF
gi watcher usage: git issue watcher [-r] <sha> <tag> ...
-r Remove the specified watcher
USAGE_watcher_EOF
exit 2
}
sub_watcher()
{
file_add_rm watcher watchers "$@"
}
# comment: Comment on an issue {{{1
usage_comment()
{
cat <<\USAGE_comment_EOF
gi comment usage: git issue comment <sha>
USAGE_comment_EOF
exit 2
}
sub_comment()
{
local isha csha path
test -n "$1" || usage_comment
cdissues
path=$(issue_path_part "$1") || exit
isha=$(issue_sha "$path")
mkdir -p "$path/comments" || error "Unable to create comments directory"
trans_start
commit 'gi: Add comment' "gi comment mark $isha"
csha=$(git rev-parse HEAD)
cp templates/comment "$path/comments/$csha" || trans_abort
edit "$path/comments/$csha" || trans_abort
git add "$path/comments/$csha" || trans_abort
commit 'gi: Add comment message' "gi comment message $isha $csha"
echo "Added comment $(short_sha "$csha")"
}
# edit: Edit an issue's description
usage_edit()
{
cat <<\USAGE_edit_EOF
gi edit usage: git issue edit [-c] <sha>
USAGE_edit_EOF
exit 2
}
sub_edit()
{
local isha csha path comment fullpath OPTIND
while getopts c flag ; do
case $flag in
c)
comment=1
;;
?)
usage_edit
;;
esac
done
shift $((OPTIND - 1));
test -n "$1" || usage_edit
cdissues
if [ -z "$comment" ] ; then
# Edit Issue
path=$(issue_path_part "$1") || exit
isha=$(issue_sha "$path")
trans_start
edit "$path/description" || trans_abort
git add "$path/description" || trans_abort
commit 'gi: Edit issue description' "gi edit description $isha"
echo "Edited issue $(short_sha "$isha")"
else
# Edit Comment
commit=$(git show --format='%b' "$1" 2> /dev/null ) || error "Unknown or ambigious comment specification $1"
# get issue sha
isha=$(echo "$commit" | sed 's/gi comment mark //')
echo "$isha" | grep -q '^[a-f0-9]\+$' || error "Not a comment sha."
path=$(issue_path_part "$isha")
# Get full comment sha
csha=$(git rev-parse "$1")
# shellcheck disable=SC2206
# SC2128: Expanding an array without an index only gives the first element.
edit "$path/comments/$csha" || trans_abort
git add "$path/comments/$csha" || trans_abort
commit 'gi: Edit comment' "gi edit comment $csha"
echo "Edited comment $(short_sha "$csha")"
fi
}
# shellcheck source=lib/git-issue/import-export.sh
. "$MY_LIB/import-export.sh"
# list: Show issues matching a tag {{{1