File: 05-Creating-an-issue.md

package info (click to toggle)
gcli 2.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, trixie
  • size: 2,096 kB
  • sloc: ansic: 19,013; makefile: 312; yacc: 261; sh: 142; lex: 53
file content (64 lines) | stat: -rw-r--r-- 1,973 bytes parent folder | download | duplicates (2)
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
# Creating an issue

**Note**: This assumes you have [configured gcli with an account](./04-Account-Setup.html) for Github already.

## Preparation

For this case I have a playground repository that you may as well use
for testing with gcli. It is available at
`herrhotzenplotz/ghcli-playground`.

To see a list of issues, we can run:

    $ gcli -t github issues -o herrhotzenplotz -r ghcli-playground -a
    NUMBER  NOTES  STATE   TITLE
        13      0  open    yet another issue
        12      0  closed  wat
        11      0  closed  blaaaaaaaaaaaaaaaaaaaah
        10      0  closed  "this is the quoted" issue title? anyone?"
         9      0  closed  test
         8      0  closed  foobar
         7      0  closed  foobar
         5      0  closed  test2
         4      0  closed  test
    $

## Invoke gcli
Let's create a bug report where we complain about things not working:

    $ gcli -t github issues create -o herrhotzenplotz -r ghcli-playground \
        "Bug: Doesn't work on my machine"

The message "Bug: doesn't work on my machine" is the title of the
issue.

## Original Post

You will see the default editor come up and instruct you to type in a
message. This message is the "original post" or the body of the issue
ticket that you're about to submit. You can use Markdown Syntax:

     I tried building this code on my machine but unfortunately it errors
     out with the following message:

     ```console
     $ make love
     make: don't know how to make love. Stop

     make: stopped in /tmp/wat
     $
     ```

     What am I doing wrong?

     ! ISSUE TITLE : Bug: Doesn't work on my machine
     ! Enter issue description above.
     ! All lines starting with '!' will be discarded.

## Submit the issue

After you save and exit the editor gcli gives you a chance to check
back and finally submit the issue. Type 'y' and hit enter.

You can check back if the issue was created and also view details
about it as you learned earlier.