SAP / project-portal-for-innersource

Lists all InnerSource projects of a company in an interactive and easy to use way. Can be used as a template for implementing the "InnerSource portal" pattern by the InnerSource Commons community.
https://sap.github.io/project-portal-for-innersource/
Apache License 2.0
143 stars 71 forks source link

search in repositories tags #11

Closed mehrdadrad closed 3 years ago

mehrdadrad commented 3 years ago

It would be great if the search supports tags as well!

spier commented 3 years ago

Good idea. Just to double check that I understand it correctly, do you mean the thing that GitHub calls topics? (see screenshot based on this repo here)

topics_example

mehrdadrad commented 3 years ago

@spier yes exactly.

spier commented 3 years ago

Great, thanks.

Did you confirm that the tool does indeed not consider the topics when searching? I tried to verify what you said in the demo but couldn't because that contains just test data and no real repos. Are you running your own instance of this with your own data or similar?

Just wondering how to describe the current and desired behavior in the most specific way, in case somebody wants to pick this up and implement it.

mehrdadrad commented 3 years ago

Confirmed, I tried an instance which another group installed and noticed it doesn't care about topics. I think topics are great keywords that they should be considered. (enhancing search feature)

Michadelic commented 3 years ago

Great idea, unfortunately topics are not included in the GitHub repository search response so we need to change the crawler logic to include topics as well. They could be fetched with a separate call for each repository and merged with the metadata as topics in the resulting repos.json JSON file: https://docs.github.com/en/rest/reference/repos#get-all-repository-topics

{
  "name": "repository",
   ...
   "topics": [
       "octocat",
       "atom",
       "electron",
       "api"
   ]
}

Including topics in the search should be easy once this is done. Feel free to contribute this feature.

Kind Regards, Michael

Michadelic commented 3 years ago

great contribution, thank you @spier !

Michadelic commented 3 years ago

@spier i updated the documentation as well, kindly check my PR #13

Michadelic commented 3 years ago

All done 🏁