feat: use code search to select repositories #399
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jamestelfer
force-pushed
the
add-code-search
branch
from
a024ba5
to
907088b
Compare
jamestelfer
force-pushed
the
add-code-search
branch
from
907088b
to
2d695d9
Compare
(GitHub only) Introduces the `--code-search` flag that allows the provision of GitHub Code Search terms (legacy) to define the selection of repositories to be visited. The repository list will be the unique set of repositories referenced in the code search results.
jamestelfer
force-pushed
the
add-code-search
branch
from
2d695d9
to
e3a2f7e
Compare
|
@lindell this should now be ready for review, all feedback (including "I don't want this") is welcome. |
lindell
reviewed
Oct 31, 2023
jamestelfer
commented
Nov 1, 2023
Co-authored-by: Johan Lindell <[email protected]>
jamestelfer
force-pushed
the
add-code-search
branch
from
419b1b5
to
06f1e25
Compare
Use this from the x/exp package instead of a handrolled version. It's likely that this package will roll into later versions of Go in a very similar form, allowing for a smooth transition.
jamestelfer
force-pushed
the
add-code-search
branch
2 times, most recently
from
75931ee
to
fd950f2
Compare
|
I followed up on the use of Hopefully the changes are small enough to make sense though. I think I've followed up on all the requested feedback, with #414 raised to follow up on one point. Let me know if there's anything further you'd like me to look at! |
lindell
approved these changes
Nov 9, 2023
| @@ -28,7 +28,8 @@ func configurePlatform(cmd *cobra.Command) { | |||
| flags.StringSliceP("group", "G", nil, "The name of a GitLab organization. All repositories in that group will be used.") | |||
| flags.StringSliceP("user", "U", nil, "The name of a user. All repositories owned by that user will be used.") | |||
| flags.StringSliceP("repo", "R", nil, "The name, including owner of a GitHub repository in the format \"ownerName/repoName\".") | |||
| flags.StringP("repo-search", "", "", "Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use `fork:true` to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories") | |||
| flags.StringP("repo-search", "", "", "Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use `fork:true` to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories.") | |||
| flags.StringP("code-search", "", "", "Use a code search to find a set of repositories to target (GitHub only). Repeated results from a given repository will be ignored, forks are NOT included by default (use `fork:true` to include them). See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-code.") | |||
There was a problem hiding this comment.
Repeated results from a given repository will be ignored, forks are NOT included by default
This is technically true for all results, but I think it might still be good to add for this one.
|
Included in release v0.49.0 🎉 |
This was referenced Jan 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this change
Using the
--code-searchoption, it is possible to supply a GitHub code search query that is used to generate the set of repositories to process.This feature is GItHub-only at the moment.
One caveat to be aware of is that the GitHub API does not yet support queries using the more recent (and much more capable) code search engine. We need to be clear which documentation to use for the search syntax.
Documentation:
What issue does it fix
Closes #401
See also:
Notes for the reviewer
Checklist