realaravinth/debian-mirror-gitlab
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
debian-mirror-gitlab/doc/integration/sourcegraph.md
Vinay Keshava 081c1a8e73 New upstream version 15.9.2+ds1
2023-04-23 21:23:45 +05:30

5.3 KiB
Raw Blame History

stage group info type
Create Source Code To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments reference, how-to

Sourcegraph (FREE)

FLAG: On self-managed GitLab, by default this feature is available. To hide the feature, ask an administrator to disable the feature flag named sourcegraph. On GitLab.com, this feature is available for public projects only.

Sourcegraph provides code intelligence features, natively integrated into the GitLab UI.

For GitLab.com users, see Sourcegraph for GitLab.com.

Sourcegraph demo

For an overview, watch the video Sourcegraph's new GitLab native integration.

NOTE: This feature requires user opt-in. After Sourcegraph has been enabled for your GitLab instance, you can choose to enable Sourcegraph through your user preferences.

Set up for self-managed GitLab instances (FREE SELF)

Before you can enable Sourcegraph code intelligence in GitLab you must: configure a Sourcegraph instance with your GitLab instance as an external service.

Set up a self-managed Sourcegraph instance (FREE SELF)

If you are new to Sourcegraph, head over to the Sourcegraph installation documentation and get your instance up and running.

If you are using an HTTPS connection to GitLab, you must configure HTTPS for your Sourcegraph instance.

Connect your Sourcegraph instance to your GitLab instance

  1. Navigate to the site Admin Area in Sourcegraph.
  2. Configure your GitLab external service. You can skip this step if you already have your GitLab repositories searchable in Sourcegraph.
  3. Validate that you can search your repositories from GitLab in your Sourcegraph instance by running a test query.
  4. Add your GitLab instance URL to the corsOrigin setting in your site configuration.

Configure your GitLab instance with Sourcegraph

  1. On the top bar, select Main menu > Admin.
  2. On the left sidebar, select Settings > General.
  3. Expand the Sourcegraph configuration section.
  4. Check Enable Sourcegraph.
  5. Set the Sourcegraph URL to your Sourcegraph instance, such as https://sourcegraph.example.com.

Sourcegraph administration settings

Enable Sourcegraph in user preferences

If a GitLab administrator has enabled Sourcegraph, you can enable this feature in your user preferences.

In GitLab:

  1. In the upper-right corner, select your avatar.
  2. Select Preferences.
  3. In the Integrations section, select the checkbox under Sourcegraph.
  4. Select Save changes.

Sourcegraph user preferences

Using Sourcegraph code intelligence

Once enabled, participating projects display a code intelligence popover available in the following code views:

  • Merge request diffs
  • Commit view
  • File view

When visiting one of these views, you can now hover over a code reference to see a popover with:

  • Details on how this reference was defined.
  • Go to definition, which navigates to the line of code where this reference was defined.
  • Find references, which navigates to the configured Sourcegraph instance, showing a list of references to the highlighted code.

Sourcegraph demo

Sourcegraph for GitLab.com

Sourcegraph powered code intelligence is available for all public projects on GitLab.com.

Support for private projects is not yet available for GitLab.com; follow the epic &2201 for updates.

Troubleshooting

Sourcegraph isn't working

If you enabled Sourcegraph for your project but it isn't working, Sourcegraph may not have indexed the project yet. You can check if Sourcegraph is available for your project by visiting https://sourcegraph.com/gitlab.com/<project-path>replacing <project-path> with the path to your GitLab project.

Sourcegraph and Privacy

From the Sourcegraph extension documentation which is the engine behind the native GitLab integration:

Sourcegraph integrations never send any logs, pings, usage statistics, or telemetry to Sourcegraph.com. They connect only to Sourcegraph.com as required to provide code intelligence or other functionality on public code. As a result, no private code, private repository names, usernames, or any other specific data is sent to Sourcegraph.com.