Fix --milestone flag on issues list command

[fsmiamoto]

This PR adds a fix to the --milestone flag on the issues list command as described in #1441

$ cli issue list --milestone "AWS Migration"

Showing 1 of 1 issue in Safecast/safecastapi that matches your search

#89  Need How To restore from backup    about 1 year ago

I'm not sure if the approach I took was the best one so any feedback would be great 👍

Edit:
Closes #1441

[fsmiamoto]

The use of the REST API appears to be unavoidable since the GraphQL API does not provide the necessary ID for the use in the query.

Hopefully this could change in the future to avoid this workaround.

[mislav]

Excellent; thanks for tackling this!

[fsmiamoto]

@mislav
Thanks for the review, I think I've managed to implement the necessary changes

[tierninho]

Thanks for the PR! I played around with this and here are some findings:

1. There should be some type of "no match" result if the following is run gh issue list --milestone "sdhfsdhjf".

   Currently it returns this:

   Showing 5 of 5 issues in tierninho/Blah that match your search
   
   #12  sdfsdf                          about 1 minute ago
   #10  sdfsdfsdfssfdssdf  (duplicate)  about 1 minute ago
   #5   sdfsdf                          about 6 months ago
   #4   My issue title                  about 1 minute ago
   #3   My issue title                  about 8 months ago
   

   it instead should show something like:

   No milestones match your search in tierninho/Blah

2. The help menu should be edited from:
   -m, --milestone name Filter by milestone name
   to
   -m, --milestone string Filter by milestone

[mislav]

Almost there! One small but important change needed before we would merge this.

[fsmiamoto]

@tierninho @mislav
Thanks for comments!

I've added the check for a not found milestone, alongside with a test, and it should solve the first issue pointed out by @tierninho.

For the second one, it looks like the pattern of using name is spread through out the project so I suggest we make no changes.

[tierninho]

Thanks for adding below @fsmiamoto

no milestone found with title: "sdhfsdhjf"

One nitpick though: please wrap it with two empty lines like the pic, as it will match current messaging. Appreciate it!

[mislav]

Fantastic. Thank you so much!

[fsmiamoto]

Thanks for testing it out @tierninho 👍

As for the formatting, since we raise an error for not finding the milestone, I've tried to keep to stick to the existing pattern.

I definitely agree that it looks better on the second command but since it doesn't actually raise an error, the output is handled differently.

[matschaffer]

That looks great! Nice work @fsmiamoto - love that http://github.com/safecast got an implicit mention in all this 😆