Add GitHub search option/feature for #733 #737
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
This is somewhat of a rough PoC for enabling the use of GitHub repo search, rather than relying on a list of all repos accessible to the user. In the future, there might be a more user-friendly way to do this. Anyways, this adds two new GitHub-related env vars: - `GITHUB_USE_SEARCH`: if `true`, uses octonode's `search.reposAsync` instead of `reposAsync` passing in a search query - `GITHUB_SEARCH_QUERY`: specifies the search query to use when searching for repos for Threat Dragon to use A conditional check in `threatmodelcontroller` determines whether to use `reposAsync` _or_ `search.reposAsync` based on the above. Finally, this adds a wrapper function in `threatmodelrepository` to use octonode's `search.reposAsync`, passing in the aforementioned search query.
|
@quine do not worry about the failing test 'PR pipeline / Build docker image', it is because this test needs greater permissions (something I keep meaning to fix) |
|
Hello @quine , I am being a bit slow to review but should do it this weekend |
|
@jgadsden No worries! Just LMK what else I can help with (if anything). Cheers! |
jgadsden
approved these changes
Sep 9, 2023
There was a problem hiding this comment.
Good to see this new feature, thanks @quine , I will go ahead and merge
Within a few minutes they will be available on https://www.threatdragon.com/#/ - although without either GITHUB_USE_SEARCH or GITHUB_SEARCH_QUERY environment variables we should see no change
|
I have created an issue in the project pages repo to document these variables Document new environment variables #58 |
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.
Summary:
This is somewhat of a rough PoC for enabling the use of GitHub repo search, rather than relying on a list of all repos accessible to the user. In the future, there might be a more user-friendly way to do this.
This adds:
Two new GitHub-related env vars:
GITHUB_USE_SEARCH: iftrue, uses octonode'ssearch.reposAsyncinstead ofreposAsyncpassing in a search queryGITHUB_SEARCH_QUERY: specifies the search query to use when searching for repos for Threat Dragon to useA conditional check in
threatmodelcontrollerdetermines whether to usereposAsyncorsearch.reposAsyncbased on the above.A wrapper function in
threatmodelrepositoryto use octonode'ssearch.reposAsync, passing in the aforementioned search query.Description for the changelog:
Add two env var config options for using GitHub repo search (
GITHUB_USE_SEARCH) and providing a query (GITHUB_SEARCH_QUERY).Other info:
closes #733
Thanks for submitting a pull request!
Please make sure you follow our code_of_conduct.md and our contributing guidelines contributing.md