This project creates a repos.json file that can be utilized by the SAP InnerSource Portal. See sample JSON structure.
The crawler assumes that the repositories that you want to show in the portal are available in a GitHub organization, and that they all are tagged with a certain topic e.g. inner-source.
bundle install
- Copy
.env-exampleto.env - In
.envfill inORGANIZATIONwith the exact name of the GitHub organization to search in - In
.envfill inGH_TOKENwith the access token from a user that has access to the organization to search in - In
.envfill inTOPICwith the name of the topic to search for
Running the crawler will create a repos.json file containing the relevant metadata for the GitHub repos containing the given TOPIC in the given ORGANIZATION.
ruby crawler.rb
After that, copy repos.json to your instance of the SAP-InnerSource-Portal and launch the portal as outlined in their installation instructions.
- This crawler is meant to be used in combination with the SAP InnerSource Portal to list all InnerSource projects of a company.
- That portal is a reference implementation of the InnerSource Portal pattern. To understand the motivation behind using such a portal in your company, we recommend to read that pattern.
- zkoppert/innersource-crawler is another crawler implementation similar to this one, but using Python instead.
You want to contribute something to this project? That's awesome! :)
Before sending a Pull Request with a change, we recommend that you open an Issue first, to discuss the proposed change with the rest of the community.