From 7848c26bf5f0ba4d12b5d0961a3306ced98428ae Mon Sep 17 00:00:00 2001 From: The-AarushiSingh <175547726+The-AarushiSingh@users.noreply.github.com> Date: Fri, 18 Sep 2026 00:23:13 +0530 Subject: [PATCH 1/4] docs: add Linux build dependencies for universal-ctags Fixes #1633 --- CONTRIBUTING.md | 48 +++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 39 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a881eee15..e7aa6020e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,7 +43,36 @@ Want to take on an issue? Leave a comment and a maintainer may assign it to you ./install-ctags-macos.sh ``` - **Linux and other platforms:** Build from source: + **Linux and other platforms:** Build from source. + + First install the required build dependencies: + + **Debian / Ubuntu:** + ```sh + sudo apt update + sudo apt install \ + gcc make \ + pkg-config autoconf automake \ + python3-docutils \ + libseccomp-dev \ + libjansson-dev \ + libyaml-dev \ + libxml2-dev + ``` + + **Fedora / RHEL / CentOS:** + ```sh + sudo dnf install \ + gcc make \ + pkgconfig autoconf automake \ + python3-docutils \ + libseccomp-devel \ + jansson-devel \ + libyaml-devel \ + libxml2-devel + ``` + + Then build and install: ```sh curl https://codeload.github.com/universal-ctags/ctags/tar.gz/v6.1.0 | tar xz -C /tmp cd /tmp/ctags-6.1.0 @@ -55,6 +84,7 @@ Want to take on an issue? Leave a comment and a maintainer may assign it to you After installing, set `CTAGS_COMMAND` in your `.env.development.local` to the path of the installed binary (e.g. `/usr/local/bin/universal-ctags`). + 3. Install and enable Corepack so the repository uses the Yarn version pinned in `package.json`: ```sh npm install -g corepack @@ -62,11 +92,11 @@ Want to take on an issue? Leave a comment and a maintainer may assign it to you yarn --version ``` -3. Clone the repository with submodules: +4. Clone the repository with submodules: ```sh git clone --recurse-submodules https://github.com/sourcebot-dev/sourcebot.git ``` -4. Run `make` to build zoekt and install dependencies: +5. Run `make` to build zoekt and install dependencies: ```sh cd sourcebot make @@ -76,29 +106,29 @@ Want to take on an issue? Leave a comment and a maintainer may assign it to you **Note**: `make` should also be run whenever switching between branches to ensure all dependencies are upto date. -5. Start the development Docker containers for PostgreSQL and Redis. +6. Start the development Docker containers for PostgreSQL and Redis. ```sh docker compose -f docker-compose-dev.yml up -d ``` -6. Generate the database schema. +7. Generate the database schema. ```sh yarn dev:prisma:migrate:dev ``` -7. Create a copy of `.env.development` and name it `.env.development.local`. Update the required environment variables. +8. Create a copy of `.env.development` and name it `.env.development.local`. Update the required environment variables. -8. If you're using a declarative configuration file, create a configuration file and update the `CONFIG_PATH` environment variable in your `.env.development.local` file. +9. If you're using a declarative configuration file, create a configuration file and update the `CONFIG_PATH` environment variable in your `.env.development.local` file. -9. Start Sourcebot with the command: +10. Start Sourcebot with the command: ```sh yarn dev ``` A `.sourcebot` directory will be created and zoekt will begin to index the repositories found in the `config.json` file. -10. Start searching at `http://localhost:3000`. +11. Start searching at `http://localhost:3000`. ## Debugging From 4059e614964f36395ab9ae883903c392c1cb2bf2 Mon Sep 17 00:00:00 2001 From: The-AarushiSingh <175547726+The-AarushiSingh@users.noreply.github.com> Date: Fri, 18 Sep 2026 00:31:18 +0530 Subject: [PATCH 2/4] docs: update CHANGELOG for Linux ctags dependencies --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 129d5370c..972eb7da8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed - Prevented browser performance instrumentation from breaking code views when `performance.measure()` returns no value. [#1665](https://github.com/sourcebot-dev/sourcebot/pull/1665) +- - Added missing Linux build dependencies for universal-ctags in the contributing guide. [#1667](https://github.com/sourcebot-dev/sourcebot/pull/1667) ## [5.1.13] - 2026-09-12 From 542706c64c35f5fb889cc277e295875f92ca8364 Mon Sep 17 00:00:00 2001 From: The-AarushiSingh <175547726+The-AarushiSingh@users.noreply.github.com> Date: Fri, 18 Sep 2026 00:35:27 +0530 Subject: [PATCH 3/4] docs: add curl to Linux ctags build dependencies --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e7aa6020e..c1b0e6dca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -51,6 +51,7 @@ Want to take on an issue? Leave a comment and a maintainer may assign it to you ```sh sudo apt update sudo apt install \ + curl \ gcc make \ pkg-config autoconf automake \ python3-docutils \ @@ -63,6 +64,7 @@ Want to take on an issue? Leave a comment and a maintainer may assign it to you **Fedora / RHEL / CentOS:** ```sh sudo dnf install \ + curl \ gcc make \ pkgconfig autoconf automake \ python3-docutils \ From 47245359d9e804e461c08211450a0e6c7289ac55 Mon Sep 17 00:00:00 2001 From: The-AarushiSingh <175547726+The-AarushiSingh@users.noreply.github.com> Date: Fri, 18 Sep 2026 00:39:42 +0530 Subject: [PATCH 4/4] docs: remove CHANGELOG entry for documentation-only change --- CHANGELOG.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 972eb7da8..129d5370c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,7 +12,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed - Prevented browser performance instrumentation from breaking code views when `performance.measure()` returns no value. [#1665](https://github.com/sourcebot-dev/sourcebot/pull/1665) -- - Added missing Linux build dependencies for universal-ctags in the contributing guide. [#1667](https://github.com/sourcebot-dev/sourcebot/pull/1667) ## [5.1.13] - 2026-09-12