Skip to content

build: bundle ggshield binary with extension#124

Open
6d7a wants to merge 1 commit intomainfrom
6d7a/bundled-binary
Open

build: bundle ggshield binary with extension#124
6d7a wants to merge 1 commit intomainfrom
6d7a/bundled-binary

Conversation

@6d7a
Copy link
Copy Markdown
Contributor

@6d7a 6d7a commented Apr 2, 2026

Context

Currently, the extension downloads ggshield at runtime. This can cause issues in environments with no or restricted network access.

What has been done

This PR replaces the runtime download with a build-time one. The ggshield binary is downloaded and bundled with the extension in a platform-specific extension. The PR also includes a configuration parameter gitguardian.ggshieldPath that allows to override the default of the bundled ggshield.

Didn't we do this before?

We used to bundle ggshield in this extension until e99b365. This approach differs as follows:

  • binaries are not kept in the repo tree but downloaded at build-time from ggshield GitHub releases
  • we ship platform-specific extensions instead of a single extension containing binaries for all platforms

Validation

  1. Build and install the VSIX: vsce package --target darwin-arm64 --allow-missing-repository && code --install-extension gitguardian-*.vsix
  2. Reload VS Code — verify the GitGuardian sidebar loads and scanning works

PR check list

  • As much as possible, the changes include tests
  • If the changes affect the end user (new feature, behavior change, bug fix) then the PR has a changelog entry.

@6d7a 6d7a requested a review from a team as a code owner April 2, 2026 13:56
@6d7a 6d7a force-pushed the 6d7a/bundled-binary branch from 9746baf to 5ecf7c5 Compare April 2, 2026 14:02
@6d7a 6d7a force-pushed the 6d7a/bundled-binary branch from 5ecf7c5 to 1432b09 Compare April 2, 2026 15:20
@6d7a 6d7a force-pushed the 6d7a/bundled-binary branch from 1432b09 to 30aa547 Compare April 8, 2026 16:52
@6d7a 6d7a force-pushed the 6d7a/bundled-binary branch from 30aa547 to bc22a35 Compare April 8, 2026 16:54
@6d7a 6d7a requested review from GabrielCousin and agateau-gg and removed request for GabrielCousin April 8, 2026 16:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants