LSIF on GitHub

You can use GitHub Actions to (1) generate LSIF data and (2) upload it to your Sourcegraph instance.

  1. Actions to Generate LSIF index data for each language:

  2. Action to upload LSIF data.

Setup

Create a workflow file .github/workflows/lsif.yaml in your repository.

You will need configure two actions to (1) generate the LSIF data and (2) upload it to Sourcegraph. Here’s an example for generating LSIF data for a Go project:

name: LSIF
on:
  - push
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/[email protected]
      - name: Generate LSIF Data
        uses: sourcegraph/[email protected]
        with:
          verbose: "true"
      - name: Upload LSIF data
        uses: sourcegraph/[email protected]
        with:
          public_repo_github_token: ${{ secrets.PUBLIC_REPO_GITHUB_TOKEN }}

Once that workflow is committed to your repository, you will start to see LSIF workflows in the Actions tab of your repository (e.g. https://github.com/sourcegraph/sourcegraph/actions).

img/workflow.png

After the workflow succeeds, you should see LSIF-powered code intelligence on your repository on Sourcegraph.com or on GitHub with the Sourcegraph browser extension