githubopengrok

How to use OpenGrok with GitHub?

GitHub's advanced search is okay, but the OpenGrok has some desirable features.

To use OpenGrok with GitHub hosted repo's will I have to:

  1. Set up my own OpenGrok server
  2. Clone the various repos
  3. Schedule pulls to keep up-to-date

Or is there another way?

Solution

  • That is the general idea, but:

    2/ should be a full clone:

    git clone --mirror https://github.com/user/repo

    3/ can be triggered by a webhook: if you listen for the JSON payload they generate, you can then pull only where there is a push on the GitHub repo, and push back to your OpenGrok server.

    Note: you might want to exclude pull refs (refs/pull/{id}), that is the pull requests that GitHub stores in its Git repo.