https://github.com/sourcegraph/lsif-rust-action

A GitHub Action to upload LSIF data to Sourcegraph for precise code intelligence
https://github.com/sourcegraph/lsif-rust-action

Last synced: 6 months ago
JSON representation

A GitHub Action to upload LSIF data to Sourcegraph for precise code intelligence

• Host: GitHub
• URL: https://github.com/sourcegraph/lsif-rust-action
• Owner: sourcegraph
• License: mit
• Created: 2021-11-05T14:44:53.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-20T10:31:03.000Z (over 1 year ago)
• Last Synced: 2025-07-17T21:23:35.761Z (6 months ago)
• Language: Python
• Size: 20.5 KB
• Stars: 6
• Watchers: 7
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Sourcegraph Rust LSIF Indexer GitHub Action

This action generates LSIF data from Rust source code using [rust-analyzer](https://github.com/rust-analyzer/rust-analyzer). The LSIF data can be further uploaded to Sourcegraph using [lsif-upload-action](https://github.com/sourcegraph/lsif-upload-action).

## Pre-requisites

- GitHub-provided Runners should work out-of-the-box.

- Self-hosted runners need to have Python 3.5+ and `curl` installed, and the runner's target needs to be one for which [`rust-analyzer` release binaries](https://github.com/rust-analyzer/rust-analyzer/releases) are available.

## Usage

The following inputs can be set.

| name         | default   | description |

| ------------ | --------- | ----------- |

| `project_root` | `.`       | The root of the repository. |

The following is a complete example that generates the LSIF index and uploads it to [sourcegraph.com](https://sourcegraph.com). Save it in `.github/workflows/lsif.yaml`.

```

name: LSIF

on:

  - push

jobs:

  index:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v2

      - name: Generate LSIF data

        uses: sourcegraph/lsif-rust-action@main

      - name: Upload LSIF data

        uses: sourcegraph/lsif-upload-action@master

        with:

          github_token: ${{ secrets.GITHUB_TOKEN }}

```

## Contributing

If you run into issues using this GitHub Action,

please [file an issue](https://github.com/sourcegraph/lsif-rust-action/issues),

including relevant CI logs.

Contributors should abide by the [Sourcegraph Code of Conduct](https://handbook.sourcegraph.com/community/code_of_conduct).