Group issues per milestone #6178

birbilis · 2022-09-02T19:43:19Z

birbilis
Sep 2, 2022

I see I can filter issues per milestone with -m flag at
https://cli.github.com/manual/gh_issue_list

but I don't see any way to group an issue list by milestone (or do any grouping in general of issues, say by some specific flag)

I see I can list and manage milestones using
https://dev.to/optnc/manage-github-milestones-from-cli-2hkh
https://gist.github.com/doi-t/5735f9f0f7f8b7664aa6739bc810a2cc
https://github.com/valeriobelli/gh-milestone (extension one can install for gh)

but not sure what would be the best path to take in order to generate a listing of issues closed per milestone (those match releases in my specific case)

Answered by LangLangBart

Sep 3, 2022

Alternatively, go through the milestones in a loop using a small shell function.

function milestoneList {
	if [ ${#@} -ne 2 ]; then
		echo -e "!!! Respect the syntax: $0 OWNER_NAME REPO_NAME"
		return 1
	fi
	MILESTONE_TITLE=()
	while IFS='' read -r line; do MILESTONE_TITLE+=("$line"); done < <(gh api -X GET /repos/"$1/$2"/milestones -f sort=due_on -f direction=desc -f state=open --jq '.[] | .title')

	for i in "${MILESTONE_TITLE[@]}"; do
		echo -n "Milestone $i"
		GH_PAGER="cat" gh issue list --milestone "$i"  --search "sort:updated-desc" --state open --repo "$1/$2"
		echo
	done
}

View full answer

LangLangBart · 2022-09-03T15:39:53Z

LangLangBart
Sep 3, 2022

Good research.

Trac milestone system

I guess you are looking for something like this: Trac - Active Tickets By Milestone
I haven't come across a solution that lists the issues as well as you can see in the image below, but there are some flags in the gh tool that might be sufficient for you.

GitHub cli (gh) issue list with milestones

--search "milestone:* sort:updated-desc"

Any (*) issue with a milestone and sorted by last update.
- More details
  - List repository issues - milestone string [GitHub Docs]
  - Sorting search results - updated [GitHub Docs]

--limit 100

Maximum number of issues to list. ~~If you specify a number greater than 100. GitHub will ignore it and only give you 100.~~

--repo brave/brave-ios

Just a random demo repo, can be omitted if run from the desired repo.

--state all

Show all issues (open, closed)

--json milestone,number,state,title,updatedAt

Get some data points about the issues

--template ...

Make the data points pretty.
- More details
  - gh formatting

gh issue list --search "milestone:* sort:updated-desc" --limit 100 \
    --repo brave/brave-ios --state all --json milestone,number,state,title,updatedAt \
    --template '
    {{- $headerColor := "blue+b" -}}
        {{- tablerow ("ISSUE" | color $headerColor) ("MILESTONE" | color $headerColor) ("LAST UPDATE" | color $headerColor) ("TITLE" | color $headerColor) -}}
    {{- range . -}}
        {{- $stateColor := "green" -}}
            {{- if eq .state "CLOSED" -}}{{- $stateColor = "red" -}}{{- end -}}
        {{- tablerow (printf "#%v" .number | color  $stateColor) (.milestone.title | color "cyan+h") (timeago .updatedAt | color "gray+h") .title -}}
    {{- end -}}'

Demo: List of all issues with a milestone (limited to 100 issues)

Demo: List of open issues with a milestone

2 replies

birbilis Sep 3, 2022
Author

Thanks, useful info
I suppose a grouping parameter would be useful for the list command

I also noticed the gh-milestone extension was using other syntax for selecting the "open" and "closed" milestones than the syntax used to show "open" and "closed" issues by gh. Would be nice to have some consistency enforced regarding parameter parsing. In fact I couldn't find how to tell gh to list both open and closed issues, whereas the gh-milestone command-line help did mention an array as parameter when trying to filter for open/close milestones (though even with that I only found how to pass "OPEN" or "CLOSED" - it needed those in caps btw)

birbilis Sep 4, 2022
Author

did find way to list both open and closed issues, as I mention in comment at valeriobelli/gh-milestone#7 the gh-milestone extension's list -s param only has OPEN/CLOSE (case sensitive) but gh issue list has support for open/close/all (case insensitive)

LangLangBart · 2022-09-03T17:07:10Z

LangLangBart
Sep 3, 2022

Alternatively, go through the milestones in a loop using a small shell function.

function milestoneList {
	if [ ${#@} -ne 2 ]; then
		echo -e "!!! Respect the syntax: $0 OWNER_NAME REPO_NAME"
		return 1
	fi
	MILESTONE_TITLE=()
	while IFS='' read -r line; do MILESTONE_TITLE+=("$line"); done < <(gh api -X GET /repos/"$1/$2"/milestones -f sort=due_on -f direction=desc -f state=open --jq '.[] | .title')

	for i in "${MILESTONE_TITLE[@]}"; do
		echo -n "Milestone $i"
		GH_PAGER="cat" gh issue list --milestone "$i"  --search "sort:updated-desc" --state open --repo "$1/$2"
		echo
	done
}

9 replies

birbilis Sep 14, 2022
Author

To cut things sort I tried installing latest Ubuntu on Windows 11 via the Windows Store (it uses WSL2 [Windows Subsystem for Linux] underneath). But when I use this in my script to call "sort -rV" (also tried with -V -n with no luck) it seems to sort respecting the dot separator, but each part isn't sort numerically, but sorted alphabetically instead. Is it some bug in Ubuntu? Which OS are you using?

set ListMilestones=gh api -X GET /repos/%1/%2/milestones -f sort=due_on -f direction=desc -f state=all --jq ".[] | .title" ^| bash -c sort -rV

Also the list doesn't seem to come out reversed (now that I notice it, there also fewer items in that list that I get at my DOS batch version [whether I do sorting or not], aka no 0.0.xx entries, strange)

0.0.3 0.3.1 0.3.2 0.3.3 0.3.4 0.3.5 0.3.6 0.4.0 0.4.1 0.4.2 0.4.3 0.4.4 0.5.0 0.5.1 0.5.10 0.5.11 0.5.12 0.5.13 0.5.2 0.5.3 0.5.4 0.5.5 0.5.6 0.5.7 0.5.8 0.5.9 0.6.0 0.7.1 0.7.2 0.8.0

LangLangBart Sep 14, 2022

Which OS are you using?

❯ sw_vers
ProductName:	Mac OS X
ProductVersion:	10.15.7
BuildVersion:	19H2026

❯ zsh --version
zsh 5.8 (x86_64-apple-darwin17.7.0)

❯ sort --version
2.3-Apple (101.40.1)

❯ man sort | grep -A 8 '\-V'
     -V, --version-sort
             Sort version numbers.  The input lines are treated as file names
             in form PREFIX VERSION SUFFIX, where SUFFIX matches the regular
             expression "(.([A-Za-z~][A-Za-z0-9~]*)?)*".  The files are com-
             pared by their prefixes and versions (leading zeros are ignored
             in version numbers, see example below).  If an input string does
             not match the pattern, then it is compared using the byte compare
             function.  All string comparisons are performed in C locale, the
             locale environment setting is ignored.
--
             $ ls sort* | sort -V

             sort-1.022.tgz

             sort-1.23.tgz

             sort-1.23.1.tgz

             sort-1.024.tgz

Tested two cases:

sort --version-sort --reverse sort.txt
sort --field-separator . --key 1.2,1nr --key 2,2nr --key 3,3nr sort.txt

Both worked for macOS and Ubuntu and failed for Windows.

JOBS
✓ example_matrix (macos-10.15) in 6s (ID 8351011839)
  ✓ Set up job
  ✓ Check out repository
  ✓ sort version
  ✓ sort version-sort flag
  ✓ sort field-separator and key flag
  ✓ Post Check out repository
  ✓ Complete job
✓ example_matrix (macos-11) in 9s (ID 8351012016)
  ✓ Set up job
  ✓ Check out repository
  ✓ sort version
  ✓ sort version-sort flag
  ✓ sort field-separator and key flag
  ✓ Post Check out repository
  ✓ Complete job
✓ example_matrix (macos-12) in 5s (ID 8351012190)
  ✓ Set up job
  ✓ Check out repository
  ✓ sort version
  ✓ sort version-sort flag
  ✓ sort field-separator and key flag
  ✓ Post Check out repository
  ✓ Complete job
✓ example_matrix (ubuntu-18.04) in 4s (ID 8351012356)
  ✓ Set up job
  ✓ Check out repository
  ✓ sort version
  ✓ sort version-sort flag
  ✓ sort field-separator and key flag
  ✓ Post Check out repository
  ✓ Complete job
✓ example_matrix (ubuntu-20.04) in 3s (ID 8351012505)
  ✓ Set up job
  ✓ Check out repository
  ✓ sort version
  ✓ sort version-sort flag
  ✓ sort field-separator and key flag
  ✓ Post Check out repository
  ✓ Complete job
✓ example_matrix (ubuntu-22.04) in 3s (ID 8351012680)
  ✓ Set up job
  ✓ Check out repository
  ✓ sort version
  ✓ sort version-sort flag
  ✓ sort field-separator and key flag
  ✓ Post Check out repository
  ✓ Complete job
X example_matrix (windows-2022) in 26s (ID 8351012862)
  ✓ Set up job
  ✓ Check out repository
  ✓ sort version
  X sort version-sort flag
  - sort field-separator and key flag
  ✓ Post Check out repository
  ✓ Complete job
X example_matrix (windows-2019) in 30s (ID 8351013026)
  ✓ Set up job
  ✓ Check out repository
  X sort version
  - sort version-sort flag
  - sort field-separator and key flag
  ✓ Post Check out repository
  ✓ Complete job

Ubuntu used the following sort version for these tests.

sort --version
shell: /bin/bash -e {0}
##[endgroup]
sort (GNU coreutils) 8.28
Copyright (C) 2017 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

Written by Mike Haertel and Paul Eggert.

birbilis Sep 14, 2022
Author

thanks for the additional info, just tried on the interactive Ubuntu shell (launched standalone inside Windows) the following and it seems to sort as expected:

~$ echo -e "0.0.3\n0.3.1\n0.3.2\n0.3.3\n0.3.4\n0.3.5\n0.3.6\n0.4.0\n0.4.1\n0.4.2\n0.4.3\n0.4.4\n0.5.0\n0.5.1\n0.5.10\n0.5.11\n0.5.12\n0.5.13\n0.5.2\n0.5.3\n0.5.4\n0.5.5\n0.5.6\n0.5.7\n0.5.8\n0.5.9\n0.6.0\n0.7.1\n0.7.2\n0.8.0" | sort -rV

0.8.0 0.7.2 0.7.1 0.6.0 0.5.13 0.5.12 0.5.11 0.5.10 0.5.9 0.5.8 0.5.7 0.5.6 0.5.5 0.5.4 0.5.3 0.5.2 0.5.1 0.5.0 0.4.4 0.4.3 0.4.2 0.4.1 0.4.0 0.3.6 0.3.5 0.3.4 0.3.3 0.3.2 0.3.1 0.0.3

birbilis Sep 14, 2022
Author

managed to fix the semantic sorting, seems doing bash -c sort -rV passes the -rV to bash instead of passing it to sort. It needed bash -c 'sort -rV', so since I was putting it in environment variable I needed to escape the ' chars with a ^ prefix (as I was already doing for the pipe | symbol with ^|)

set ListMilestones=gh api -X GET /repos/%1/%2/milestones -f sort=due_on -f direction=desc -f state=all --jq ".[] | .title" ^| bash -c ^'sort -rV^'

However since I had created all those milestones in the same temporal order as their semantic sorting, I opted to avoid using bash (and having to install an extra Linux OS via WSL2 or install other bash-based dev environment) and just sort by number in the API call (-f sort=number -f direction=desc)

set ListMilestones=gh api -X GET /repos/%1/%2/milestones -f sort=number -f direction=desc -f state=all --jq ".[] | .title"

so the thing that remains with my DOS batch script is why it brings a smaller list of milestones, all 0.0.x are missing for example (did check that they have closed issues assigned to them just in case it played a role). I also noticed if I use -f state=closed it brings 0.2.0, but if I use state=all it doesn't bring it (last one is 0.3.0 in that case) which is even more strange

birbilis Sep 15, 2022
Author

To bypass the missing entries from the list in the DOS batch implementation of that iterative logic, I now use gh-milestone extension (installed via gh extension install valeriobelli/gh-milestone).

Discussing my use of it at the comments of this issue
valeriobelli/gh-milestone#13

As I mention in the comments there, It seems I stumbled on an issue with Github's numbering of milestones. It seems to reuse gap numbers from deleted milestones (at least that's my guess from what I see, since my 0.6.0 milestone uses number 20 whereas its direct siblings 0.5.13 and 0.7.1 use numbers 45 and 46. So I will need to use the semantic versioning sorting strategy, it's not enough to sort by number of milestone.

birbilis · 2022-09-03T23:46:24Z

birbilis
Sep 3, 2022
Author

btw, another way may be by crafting a GraphQL query, but haven't studied the GitHub APIs - https://docs.github.com/en/graphql
(UPDATE: the gist I had mentioned at the initial question seems to use GraphQL)

1 reply

LangLangBart Sep 4, 2022

Thanks, useful info

😀

I suppose a grouping parameter would be useful for the list command

Issues grouped by milestone might be a good feature for the valeriobelli/gh-milestone extension. You could open a topic there and ask if this is something he also finds worthwhile.

In fact I couldn't find how to tell gh to list both open and closed issues

❯ gh issue list -h | grep state
  -s, --state string       Filter by state: {open|closed|all} (default "open")

btw, another way may be by crafting a GraphQL query, [...]

GraphQL API could also be used, I tend to stick with the REST API because its easier to write. 😅

More details
- Migrating from REST to GraphQL

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Group issues per milestone #6178

{{title}}

Replies: 3 comments 12 replies

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

Select a reply

Group issues per milestone #6178

birbilis Sep 2, 2022

Replies: 3 comments · 12 replies

LangLangBart Sep 3, 2022

Trac milestone system

GitHub cli (gh) issue list with milestones

Demo: List of all issues with a milestone (limited to 100 issues)

Demo: List of open issues with a milestone

birbilis Sep 3, 2022 Author

birbilis Sep 4, 2022 Author

LangLangBart Sep 3, 2022

birbilis Sep 14, 2022 Author

LangLangBart Sep 14, 2022

birbilis Sep 14, 2022 Author

birbilis Sep 14, 2022 Author

birbilis Sep 15, 2022 Author

birbilis Sep 3, 2022 Author

LangLangBart Sep 4, 2022

birbilis
Sep 2, 2022

Replies: 3 comments 12 replies

LangLangBart
Sep 3, 2022

birbilis Sep 3, 2022
Author

birbilis Sep 4, 2022
Author

LangLangBart
Sep 3, 2022

birbilis Sep 14, 2022
Author

birbilis Sep 14, 2022
Author

birbilis Sep 14, 2022
Author

birbilis Sep 15, 2022
Author

birbilis
Sep 3, 2022
Author