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
|
.Dd @PACKAGE_DATE@
.Dt GCLI-COMMENT 1
.Os @PACKAGE_STRING@
.Dd $Mdocdate$
.Sh NAME
.Nm gcli comment
.Nd Comment on tickets in git forges
.Sh SYNOPSIS
.Nm
.Op Fl y
.Op Fl o Ar owner Fl r Ar repo
.Op Fl i Ar issue | Fl p Ar PR
.Sh DESCRIPTION
.Nm
can be used to add comments in the discussion under issues and pull
requests on
.Xr git 1
forges such as Github, Gitlab and Gitea. Note that PRs are treated as
issues on GitHub and Gitea, making the
.Fl i
and
.Fl p
flags exchangeable without changing the overall effect of creating the
comment.
.Nm
will open an editor, either specified in your environment through
.Ev EDITOR
or the one set in your global config file to enter the comment. See
.Xr gcli 1 .
.Sh OPTIONS
.Bl -tag -width indent
.It Fl o , -owner Ar owner
Comment in the repository of the given owner. This option can only be
used in combination with
.Fl r .
.It Fl r , -repo Ar repo
Comment in the given repository. This option can only be used in
combination with
.Fl r .
.It Fl y , -yes
Do not ask for confirmation before submitting the comment. Assume yes.
.It Fl i , -issue Ar issue
Create the comment under issue
.Ar #issue .
.It Fl p , -pull Ar pr
Create the comment under PR
.Ar #pr .
.El
.Sh EXAMPLES
Comment under PR #11 in the upstream repository:
.Bd -literal -offset indent
$ gcli comment -p 11
.Ed
.Pp
Comment under issue 1 in herrhotzenplotz/gcli:
.Bd -literal -offset indent
$ gcli comment -o herrhotzenplotz -r gcli -i 1
.Ed
.Sh SEE ALSO
.Xr git 1 ,
.Xr gcli 1 ,
.Xr gcli-issues 1 ,
.Xr gcli-pulls 1
.Sh AUTHORS
.An Nico Sonack aka. herrhotzenplotz Aq Mt nsonack@herrhotzenplotz.de
and contributors.
.Sh BUGS
There is no way to preview the markdown markup, however you can input
markdown which will be rendered on the remote site.
.Pp
Please report bugs via E-Mail to
.Mt @PACKAGE_BUGREPORT@ .
.Pp
Alternatively you can report them on any of the forges linked at
.Lk @PACKAGE_URL@ .
However, the preferred and quickest method is to use the mailing
list.
|