Skip to content

chore(release): prep 5.0.0 docs and version bump#338

Merged
mbektas merged 1 commit into
plmbr:mainfrom
pjdoland:chore/500-release-prep
May 23, 2026
Merged

chore(release): prep 5.0.0 docs and version bump#338
mbektas merged 1 commit into
plmbr:mainfrom
pjdoland:chore/500-release-prep

Conversation

@pjdoland
Copy link
Copy Markdown
Collaborator

Summary

Prep for the 5.0.0 release. Promotes the existing [Unreleased] CHANGELOG snapshot to [5.0.0] - 2026-05-22, expands it to cover everything merged into upstream/main after PR #287's docs refresh, bumps package.json from 4.8.0 to 5.0.0, and freshens README + admin-guide for the new surface.

Solution

CHANGELOG

README

docs/admin-guide.md

  • pip install example block swapped from fastmcp==2.x.* to mcp==1.27.* and notebook-intelligence==5.0.*, with a cross-reference to the changelog migration note.
  • Version matrix gains a 5.0.x row.
  • New callout in the env-var/traitlet section noting that some NBI settings live in JupyterLab's Settings Editor rather than the NBI Settings dialog. Names refresh_open_files_on_disk_change as the notable case and the overrides.json path for org-wide overrides.

package.json

  • Version bumped from 4.8.0 to 5.0.0. The Python _version.py is auto-generated by Hatchling from this value on build, so no separate Python version bump is needed.

Testing

Documentation and version-bump PR; no executable change.

  • python3 -c "import json; json.load(open('package.json'))" — package.json is valid JSON.
  • Visual check: CHANGELOG renders cleanly, all links resolve, no broken bullets.
  • Em-dash grep on added lines returned 0 hits (project convention).

Two rounds of six persona reviewers (changelog fidelity, backward-compat / semver, admin-guide cross-reference, security-claim audit, README freshness, style + Keep-a-Changelog conformance) shaped the final wording:

All fix-before-ship findings applied.

Risks / follow-ups

  • Cipher description in security: enforce 0o600 on the encrypted GitHub token file #293's CHANGELOG entry says "AES-GCM-encrypted Copilot token". The underlying cipher is Fernet (AES-128-CBC + HMAC). Out of scope for this docs PR; worth a follow-up correction since it's a minor factual nit on a security entry.
  • Admin guide HTTP kill-switch row in the Failure modes table is not added; the kill switch is documented in the dedicated subsection. Worth a future tightening.
  • README first-run tour mention in Quick start was deferred; the tour is discoverable in the UI on first open.
  • Terminal drag-drop trust-model note (docs/admin-guide.md:549) is mildly imprecise post-feat(claude): attach workspace files as @-mention in Claude mode #327 (the @-mention path bypasses the staging dir for workspace files). Worth a future tweak.

Issue linkage

No single issue — this is the 5.0.0 release prep PR. Closes the post-4.8.0 doc lag.

@pjdoland pjdoland added this to the 5.0.x milestone May 22, 2026
@pjdoland pjdoland added the documentation Improvements or additions to documentation label May 22, 2026
@mbektas
Copy link
Copy Markdown
Collaborator

mbektas commented May 22, 2026

@pjdoland can you resolve the conflicts

Promotes the [Unreleased] CHANGELOG snapshot to [5.0.0] - 2026-05-22
and expands it to cover everything merged into upstream/main after
PR plmbr#287's docs refresh. Bumps package.json to 5.0.0.

CHANGELOG additions cover the post-plmbr#287 surface:

- Settings tabs: plugin marketplace picker (plmbr#284), plugin marketplace
  details + Update button (plmbr#303), per-workspace MCP disable (plmbr#286),
  JSON-paste path in Add MCP server (plmbr#285).
- Launchers: hide-with-policy (plmbr#288), brand icons for Codex / opencode
  (plmbr#325, plmbr#333), per-launch directory picker (plmbr#332).
- Chat sidebar and agentic UX: workspace @-mention in Claude mode
  (plmbr#327), reload-open-files-on-disk (plmbr#330), steered system prompt
  away from over-eager notebook creation (plmbr#336).
- Skills: multi-manifest support (plmbr#321), tracks-upstream for user-
  imported skills (plmbr#322), HTTP kill switch for the reconciler (plmbr#291).
- Accessibility: full sub-section covering plmbr#305-plmbr#320.
- Security: shell-tool sandbox (plmbr#290), Claude UI-bridge sandbox (plmbr#323),
  0o600 on encrypted token (plmbr#293), env-secret scrubbing (plmbr#295), MCP
  config shape validation (plmbr#299), XSS allowlist (plmbr#296), Copilot WS
  auth + origin (plmbr#301), GHE host detection (plmbr#292), fastmcp -> mcp SDK
  swap (plmbr#324).
- Fixed: session listing unification (plmbr#310), session preview unwrap
  (plmbr#331), down-area runtime throw (plmbr#330 follow-up), WS message-handler
  leak (plmbr#294).
- Removed: fastmcp dependency, history.jsonl session gate.

Adds a Migration note covering the five behavior changes operators
should review before upgrading from 4.x: fastmcp swap, path
sandboxes, history.jsonl gate removal, workspace @-mention pointer
shape, and the Copilot WebSocket auth/origin tightening.

Two reviewer rounds (six personas each) applied:
- Round 1 caught security overclaims (plmbr#293, plmbr#299, plmbr#323), the
  plmbr#284/plmbr#303 mis-attribution, missing migration note, 3 em dashes,
  and the stale `fastmcp==2.x.*` recommendation in the admin guide.
- Round 2 caught the missing plmbr#301 migration bullet, missing version-
  matrix 5.0.x row, missing README TOC entry, and a couple of style
  nits (sub-heading overpromise, orphan bullet).

Skipped (deferred to future PRs):
- README first-run tour mention.
- Admin guide HTTP kill-switch row in Failure-modes table.
- Terminal drag-drop trust-model precision update after plmbr#327.
- Cipher description nit in plmbr#293 (Fernet AES-128-CBC+HMAC, not
  AES-GCM).
@pjdoland pjdoland force-pushed the chore/500-release-prep branch from c99f6c9 to f43fafa Compare May 22, 2026 23:20
@pjdoland
Copy link
Copy Markdown
Collaborator Author

Resolved. Also added doc updates relating to #339

@mbektas mbektas merged commit b6fe94e into plmbr:main May 23, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants