Marketplace-ready release: universal VSIX + simplified publish pipeline#2
Merged
Conversation
- Restructure README: install instructions, motivation, troubleshooting,
and issues sections. Existing command tables and quick visual reference
are preserved.
- Add CHANGELOG.md so the Marketplace 'Changelog' tab populates.
- package.json:
* Add bugs.url and homepage so Marketplace links resolve.
* Add categories 'Other' alongside 'SCM Providers' (Diffy consumes the
SCM API; 'Other' is the closer fit).
* Add keywords for Marketplace search.
* Add galleryBanner so the listing isn't a default-gray header.
- release.yml: harden the publish step with bash strict mode, a
zero-VSIX guard, and a sorted array passed as positional args to
vsce publish instead of unquoted command substitution.
test-fixtures/repo-seed/workspace is a throwaway repo built by seed.sh. It had been staged as a phantom submodule (mode 160000, no .gitmodules), which left the working tree perpetually dirty as tests re-seeded it. Drop the gitlink and ignore the directory. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
MelbourneDeveloper
added a commit
that referenced
this pull request
May 28, 2026
…ne (#2) <!-- agent-pmo:74cf183 --> ## TLDR Make Diffy marketplace-ready: collapse the 6-platform release pipeline into one sequential job that builds a single universal VSIX and publishes it to the VS Code Marketplace, plus marketplace metadata/docs and a fix for an accidental test-fixture gitlink. ## Details **Release pipeline (`.github/workflows/release.yml`, ~-176 lines):** - Replaced the multi-job, 6-platform VSIX matrix (linux/darwin/win x64/arm64) and the Shipwright `ci-gate`/`validate-manifest`/`stamp`/`verify` jobs with **one sequential job** triggered on a `v*` tag: `npm ci` (npm cache) → set version from tag → build → `vsce package` (no `--target`) → `vsce publish` → attach the VSIX to the GitHub release. - Diffy is pure TypeScript with no native binaries, so a single platform-agnostic VSIX serves every OS/arch — the per-platform matrix was pure overhead. - Publishes via the org-level `VSCODE_MARKETPLACE_PAT` secret, with a guard that fails loudly (with instructions to add Diffy to the secret's allowed repositories) when the secret isn't accessible. Prerelease tags (containing `-`) are flagged on the GitHub release. **Manifest (`shipwright.json`):** `platforms: ["all"]` and `artifact: "vsix-fat"` to match the universal build (was the 6-platform list + `vsix-per-platform`). **Marketplace metadata (`package.json`):** added `bugs`, `homepage`, `keywords`, `galleryBanner`, and the `Other` category. **Docs:** new `CHANGELOG.md` documenting the 0.1.0 command surface; `README.md` rewritten for marketplace users and trimmed of the contributor/Development (make-targets) section. **Fix (`.gitignore`):** `test-fixtures/repo-seed/workspace/` was tracked as an accidental gitlink (phantom submodule), leaving the working tree perpetually dirty as the E2E suite re-seeded it. It is a script-built throwaway repo, now ignored. No runtime/source code changed — release infrastructure, manifest, and docs only. No breaking changes. ## How Do The Automated Tests Prove It Works? - `make ci` passed end-to-end (exit 0): ESLint + `tsc --noEmit` + `shipwright:validate`, then the fail-fast unit + `@vscode/test-electron` E2E suite with coverage **95.06% statements / 87.97% branches / 97.82% functions** (above the ratcheted threshold), then the `tsc` build. With no source changes, the green suite proves no regression. - `npm run shipwright:validate` confirms the new `platforms: ["all"]` / `vsix-fat` manifest is schema-valid against `schemas/shipwright.schema.json`. - Verified the release path locally: `npm run build && npx vsce package` produces `diffy-0.1.0.vsix` with **no `TargetPlatform`** in `extension.vsixmanifest` (a true universal VSIX) that bundles `shipwright.json`. ---------
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
TLDR
Make Diffy marketplace-ready: collapse the 6-platform release pipeline into one sequential job that builds a single universal VSIX and publishes it to the VS Code Marketplace, plus marketplace metadata/docs and a fix for an accidental test-fixture gitlink.
Details
Release pipeline (
.github/workflows/release.yml, ~-176 lines):ci-gate/validate-manifest/stamp/verifyjobs with one sequential job triggered on av*tag:npm ci(npm cache) → set version from tag → build →vsce package(no--target) →vsce publish→ attach the VSIX to the GitHub release.VSCODE_MARKETPLACE_PATsecret, with a guard that fails loudly (with instructions to add Diffy to the secret's allowed repositories) when the secret isn't accessible. Prerelease tags (containing-) are flagged on the GitHub release.Manifest (
shipwright.json):platforms: ["all"]andartifact: "vsix-fat"to match the universal build (was the 6-platform list +vsix-per-platform).Marketplace metadata (
package.json): addedbugs,homepage,keywords,galleryBanner, and theOthercategory.Docs: new
CHANGELOG.mddocumenting the 0.1.0 command surface;README.mdrewritten for marketplace users and trimmed of the contributor/Development (make-targets) section.Fix (
.gitignore):test-fixtures/repo-seed/workspace/was tracked as an accidental gitlink (phantom submodule), leaving the working tree perpetually dirty as the E2E suite re-seeded it. It is a script-built throwaway repo, now ignored.No runtime/source code changed — release infrastructure, manifest, and docs only. No breaking changes.
How Do The Automated Tests Prove It Works?
make cipassed end-to-end (exit 0): ESLint +tsc --noEmit+shipwright:validate, then the fail-fast unit +@vscode/test-electronE2E suite with coverage 95.06% statements / 87.97% branches / 97.82% functions (above the ratcheted threshold), then thetscbuild. With no source changes, the green suite proves no regression.npm run shipwright:validateconfirms the newplatforms: ["all"]/vsix-fatmanifest is schema-valid againstschemas/shipwright.schema.json.npm run build && npx vsce packageproducesdiffy-0.1.0.vsixwith noTargetPlatforminextension.vsixmanifest(a true universal VSIX) that bundlesshipwright.json.