Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,22 @@ jobs:
dist-release/stackglass-cursor-plugin.zip
dist-release/checksums.txt
body: |
Stackglass 1.1.0 is a **GitHub Release**, not an npm package. Do not `npm install stackglass` or `npm link`.
Stackglass is a **GitHub Release**, not an npm package. Do not `npm install stackglass`, `npm link`, or `npm publish`.

Requires **Node.js >= 22.13.0**.

Cursor plugin: https://cursor.directory/plugins/stackglass

Full artifact instructions: https://github.com/theworker02/stackglass/blob/master/docs/RELEASE.md

## Artifacts

- `stackglass-cli.zip` — built CLI plus the MCP server and production dependencies
- `stackglass-mcp.zip` — same runtime; start with `node scripts/stackglass-mcp.mjs`
- `stackglass-cursor-plugin.zip` — Cursor Open Plugins layout
- `checksums.txt` — SHA-256 of the zips
- `stackglass-cli.zip` — built CLI plus the MCP server and production dependencies. Run `node cli/dist/bin.js help`.
- `stackglass-mcp.zip` — same runtime tree as the CLI zip. Start with `STACKGLASS_ROOT=/your/project node scripts/stackglass-mcp.mjs`.
- `stackglass-cursor-plugin.zip` — Cursor Open Plugins layout (`.cursor-plugin/plugin.json`). Prefer the cursor.directory listing when you can.
- `checksums.txt` — SHA-256 of the three zips. Verify before you run an extracted tree.

The CLI zip and MCP zip are the same runnable tree. The plugin zip is a different layout and does not include `cli/dist`.

## CLI

Expand All @@ -58,14 +64,20 @@ jobs:
node scripts/glass.mjs init
```

## MCP (22 tools)
If `node_modules` is missing: `npm install --omit=dev --ignore-scripts` inside the extracted tree only.

## MCP (exactly 22 tools)

```bash
STACKGLASS_ROOT=/path/to/your/project node scripts/stackglass-mcp.mjs
```

`STACKGLASS_ROOT` is the workspace to observe. New capability is an optional argument, never a 23rd tool.

## Cursor plugin

Extract `stackglass-cursor-plugin.zip` and add that folder as a Cursor plugin. `mcp.json` starts `node scripts/stackglass-mcp.mjs`.
Install from https://cursor.directory/plugins/stackglass or extract `stackglass-cursor-plugin.zip` and add that folder as a Cursor plugin. `mcp.json` starts `node scripts/stackglass-mcp.mjs` and sets `STACKGLASS_ROOT` to the workspace.

You still need the CLI zip or a built clone to run `init`, `status`, and `dashboard`.

Docs: https://theworker02.github.io/stackglass/
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added

- Documentation site landing with glass/stacked-pane theme, Cursor plugin CTA, and sections for the 22 tools, GlassLab, GlassLens, dashboard, privacy, and install
- In-repo [docs/RELEASE.md](docs/RELEASE.md) covering each GitHub Release zip, checksums, and plugin vs CLI vs MCP
- README install CTA for the Cursor plugin at https://cursor.directory/plugins/stackglass

### Changed

- README, getting-started docs, troubleshooting, and published v1.1.0 release notes expanded with source install, `STACKGLASS_ROOT`, and artifact usage
- `scripts/write-docs.mjs` refuses to overwrite the hand-crafted `apps/docs/index.md`

### Fixed

### Deprecated
Expand Down
13 changes: 10 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,17 +45,24 @@ The public MCP surface is 22 tools. Prefer new arguments or UI/CLI commands over

Docs are VitePress in `apps/docs`. Keep README commands accurate. Update CHANGELOG for user-facing changes.

The homepage (`apps/docs/index.md` plus `.vitepress/theme`) is hand-crafted. `scripts/write-docs.mjs` must not write `index.md`. After regenerating inner pages, run `DOCS_BASE=/stackglass/ npm run docs:build`.

The Cursor plugin listing to link from README and the site is https://cursor.directory/plugins/stackglass.

## Pull requests

Use the pull request template. Small, focused changes. Do not commit `.env`, credentials, or `.stackglass/local.json`.

## Release process

Follow [docs/RELEASE.md](docs/RELEASE.md). Short version:

1. `npm test` and `npm run build`
2. `npx glass release` against this repository (dogfood)
3. Update CHANGELOG
4. Tag `vX.Y.Z` and push the tag
2. `node cli/dist/bin.js release` against this repository (dogfood). Never `npx glass` from npm.
3. Update CHANGELOG and `docs/RELEASE.md` if artifact usage changed
4. Tag `vX.Y.Z` and push the tag. `master` is protected: require a pull request, no force-push.
5. GitHub Actions `release.yml` attaches `stackglass-cli.zip`, `stackglass-mcp.zip`, `stackglass-cursor-plugin.zip`, and `checksums.txt`. `docs.yml` deploys GitHub Pages.
6. Expand the published release body so it matches `docs/RELEASE.md` (`gh release edit vX.Y.Z --notes-file docs/RELEASE.md`).

The Cursor plugin files belong at the repository root. Do not add `.cursor-plugin/marketplace.json` unless this repo becomes a multi-plugin marketplace.

Expand Down
Loading
Loading