You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,10 +49,10 @@ npm version patch # or minor, major
49
49
50
50
This single command:
51
51
52
-
1.**preversion**-- verifies you're on `main`, runs build + tests
52
+
1.**preversion**— verifies you're on `main`, runs build + tests
53
53
2. Bumps version in package.json
54
54
3. Commits the version bump and creates a `v*` tag
55
-
4.**postversion**-- pushes the commit and tag to origin
55
+
4.**postversion**— pushes the commit and tag to origin
56
56
57
57
CI then takes over:
58
58
@@ -71,7 +71,7 @@ Trigger the full build/package pipeline without publishing:
71
71
gh workflow run ci.yml --ref dev
72
72
```
73
73
74
-
This runs with `dry_run=true` (the default), which builds binaries, packages VSIX files, and verifies their contents -- but skips the GitHub release and marketplace publish steps. Uncheck `dry_run` in the GitHub UI to publish from a manual dispatch (only allowed from `main`).
74
+
This runs with `dry_run=true` (the default), which builds binaries, packages VSIX files, and verifies their contents — but skips the GitHub release and marketplace publish steps. Uncheck `dry_run` in the GitHub UI to publish from a manual dispatch (only allowed from `main`).
75
75
76
76
### Recovery
77
77
@@ -91,13 +91,13 @@ npm version patch
91
91
92
92
### Branches
93
93
94
-
-**main**-- releases happen here; `npm version` enforces this via a branch guard
95
-
-**dev**-- CI runs tests and dry-run builds; publish steps are gated behind `dry_run` input and a main-branch guard
94
+
-**main**— releases happen here; `npm version` enforces this via a branch guard
95
+
-**dev**— CI runs tests and dry-run builds; publish steps are gated behind `dry_run` input and a main-branch guard
96
96
97
97
## CI
98
98
99
99
GitHub Actions (`.github/workflows/ci.yml`):
100
100
101
-
-**test**-- runs on every push to `main`/`dev` and on PRs to `main`
102
-
-**build-git-crypt**-- compiles static git-crypt binaries on macOS (arm64 via macos-15) and Linux (x64 and arm64 via Alpine Docker, arm64 uses QEMU). Runs on tags and `workflow_dispatch`
103
-
-**publish**-- packages platform-specific and universal VSIX files, verifies contents, optionally creates GitHub release and publishes to marketplace. Release/publish steps are controlled by the `dry_run` input (defaults to true on manual dispatch; always false on tag pushes)
101
+
-**test**— runs on every push to `main`/`dev` and on PRs to `main`
102
+
-**build-git-crypt**— compiles static git-crypt binaries on macOS (arm64 via macos-15) and Linux (x64 and arm64 via Alpine Docker, arm64 uses QEMU). Runs on tags and `workflow_dispatch`
103
+
-**publish**— packages platform-specific and universal VSIX files, verifies contents, optionally creates GitHub release and publishes to marketplace. Release/publish steps are controlled by the `dry_run` input (defaults to true on manual dispatch; always false on tag pushes)
Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,17 +6,17 @@ VSCode extension that makes [git-crypt](https://github.com/AGWA/git-crypt) repos
6
6
7
7
## The Problem
8
8
9
-
VSCode's extension host process uses a minimal `PATH` that often excludes directories like `/opt/homebrew/bin`-- even when VSCode is launched from a terminal with the full PATH configured. This means the `git-crypt` clean/smudge filter fails with `git-crypt: command not found`, which can prevent the entire repository from loading in the SCM panel.
9
+
VSCode's extension host process uses a minimal `PATH` that often excludes directories like `/opt/homebrew/bin`— even when VSCode is launched from a terminal with the full PATH configured. This means the `git-crypt` clean/smudge filter fails with `git-crypt: command not found`, which can prevent the entire repository from loading in the SCM panel.
10
10
11
11
## How It Works
12
12
13
-
On macOS and Linux, the extension ships a bundled `git-crypt` binary. No separate installation needed -- the extension appends its binary to `PATH` so git's clean/smudge filters just work. If you already have git-crypt installed, your version takes precedence.
13
+
On macOS and Linux, the extension ships a bundled `git-crypt` binary. No separate installation needed — the extension appends its binary to `PATH` so git's clean/smudge filters just work. If you already have git-crypt installed, your version takes precedence.
14
14
15
15
Git-crypt files are also decorated with a lock badge so you can identify them at a glance.
16
16
17
17
## Usage
18
18
19
-
With the extension installed, git-crypt files work like any other file in the Source Control panel -- double-click to diff, stage with the `+` icon, etc.
19
+
With the extension installed, git-crypt files work like any other file in the Source Control panel — double-click to diff, stage with the `+` icon, etc.
0 commit comments