pocket icon indicating copy to clipboard operation
pocket copied to clipboard

[Tooling] MVP GitHub comment search interface

Open bryanchriswhite opened this issue 1 year ago • 1 comments

Objective

Enable basic searching of GitHub issue and PR/review comments. Help me find things I know exist but are burried under "load more" and "show resolved" buttons in the GitHub UI.

Origin Document

Frustration: image

Goals

  • Support case-insensitive, full-text search of GitHub issue, PR, and review comments on a given repo.
  • Initially sort results by creation date, in descending order
  • Provide context for each result:
    • comment body (optionally truncated)
    • comment author
    • comment URL

Deliverable

  • [ ] Add docs, incl. creating GitHub access token (GH docs)
  • [ ] Python CLI supporting MVP GitHub comment search

Illustrative usage:

usage: search [pulls|issues] [OPTIONS] <search text> 

OPTIONS:
    -r, --repo <owner/name>         GitHub repository to search, specified as `owner/name` (default: "pokt-network/pocket")
    -s, --since <date ISO 8601>     Earliest issue/review commment date to consider (default: 6 months ago)
    -p, --pulls <PR#>[, ...]        Specific pull request(s) to consider (default: all repo PRs)
    -i, --issues <issue#>[, ...]    Specific issue(s) to consider (default: all repo issues)
    -u, --users <user>[, ...]       Specific user(s) to consider (default: all participating users)

Non-goals / Non-deliverables

  • Local indexing (i.e. adding Python web server and/or database dependencies)
  • Access token generation / automation

General issue deliverables

  • [ ] Update the appropriate CHANGELOG(s)
  • [ ] Update any relevant local/global README(s)
  • [ ] Update relevant source code tree explanations
  • [ ] Add or update any relevant or supporting mermaid diagrams

Testing Methodology

  • [ ] All tests: make test_all
  • [ ] LocalNet: verify a LocalNet is still functioning correctly by following the instructions at docs/development/README.md

Creator: @bryanchriswhite

bryanchriswhite avatar Mar 29 '23 16:03 bryanchriswhite

Being built here!! https://github.com/bryanchriswhite/full-comment-search

Olshansk avatar Apr 18 '23 15:04 Olshansk