Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

37 lines (22 loc) · 1.81 KB
Raw

Contributing

Building and running the unit tests

Just run make.

For crossbuilding run make crossbuild.

Note that the langserver doesn't have proper integration tests yet, so manual testing of changed functionality is usually necessary.

PRs that improve the test situation are highly appreciated.

Manually testing the language server

The easiest way to test the language server is to use the VS Code extension

To use your own build of the language server:

  • Clone the extension repo and open it in VS Code.
  • Press F5 to run the extension. A VS Code instance with the extension running will open in a second window. The debug console in the first window shows logs and stack traces.
  • In the VS Code settings, set Extensions -> PromQL -> Langserver Binary Path (Graphical settings menu) or promql.langserverBinaryPath (settings.json) to the absolute path of your language server build.
  • After every rebuild, hit Ctrl + Shift + P -> Developer: Reload Window.

Internal dependencies

This repo has a dependencies that are in a marked as internal in their source repo and cannot be easily imported.

To manage these special steps are required.

For each of them there exists a respective directory in vendored/<name> and a couple of metadata files:

  • <name>.repo contains the source repo of the dependency
  • <name>.version contains the commit id that should be checked out before copying the files over in this repo
  • <name>.dirs contains the directories that should be copied over
  • <name>.cmd contains a sed command to be run on all imported files to fix import paths

To update these dependencies, set the appropriate version and run make update_internal_packages. Then fix every problem the update caused. This should be done every few weeks or so.