Skip to content

docs: minimal updates for releases 1.62–1.69#4868

Merged
drernie merged 11 commits into
masterfrom
docs/release-notes-update
May 1, 2026
Merged

docs: minimal updates for releases 1.62–1.69#4868
drernie merged 11 commits into
masterfrom
docs/release-notes-update

Conversation

@drernie
Copy link
Copy Markdown
Member

@drernie drernie commented May 1, 2026

Summary

Walks through release notes for 1.62 through 1.69 and adds minimal documentation for items not already covered, one commit per version.

  • 1.62 — Qurator developer tools (swappable models, session recordings) in Catalog/Qurator.md
  • 1.63 — Bucket file upload/delete and zero-config package creation in Catalog/FileBrowser.md
  • 1.64 — Visual package revision diffs in walkthrough/working-with-the-catalog.md
  • 1.65.h5ad AnnData preview (Catalog/Preview.md) and CRC64Checksums parameter (CHUNKED_CHECKSUMS.md)
  • 1.66ui.actions.deleteObject default-off note in Catalog/Preferences.md
  • 1.67 — Graviton (ARM) Elasticsearch eligibility in walkthrough/working-with-elasticsearch.md
  • 1.68 — Copy URI button (Catalog/FileBrowser.md) and Graviton2 ES default (working-with-elasticsearch.md)
  • 1.69 — Prefix-scoped bucket reindex API in Catalog/Admin.md

Features already covered in earlier docs PRs (Benchling webhook, MCP/Connect server, API Keys, union_roles SSO, theme logo upload, async Benchling canvas, subdomain wildcards, QuiltSync changes) were left untouched.

Test plan

  • Spot-check rendered docs pages for each updated file
  • Verify cross-references and section anchors still resolve

🤖 Generated with Claude Code

Greptile Summary

This PR adds minimal documentation for Quilt releases 1.62–1.69 across nine docs files, covering Qurator developer tools, bucket file upload/delete, zero-config package creation, visual revision diffs, AnnData preview, CRC64/NVME checksums, ui.actions.deleteObject default-off behavior, Graviton2 Elasticsearch defaults, Copy URI button, and prefix-scoped reindex API. Issues flagged in previous review threads (versioning qualifier for delete markers, successors vs ui.sourceBuckets clarification, CRC64/NVME capitalization) have all been addressed in this revision.

Confidence Score: 5/5

Safe to merge; only finding is a minor broken anchor fragment in a cross-reference link.

All changes are documentation-only. The single issue found is a P2 broken anchor (#api-keys vs #api-key-authentication) in MCP-Server.md that still navigates to the correct page. All previous P1 concerns from prior review threads have been resolved.

docs/Catalog/MCP-Server.md — broken anchor in authentication.md cross-reference link

Important Files Changed

Filename Overview
docs/Catalog/MCP-Server.md Adds 'Headless Access with API Keys' section; anchor #api-keys in the authentication.md cross-reference is broken (actual heading slug is #api-key-authentication).
docs/Catalog/Admin.md Adds prefix-scoped reindex API section; content is accurate and well-scoped.
docs/Catalog/FileBrowser.md Adds upload/delete, zero-config package creation, and Copy URI button sections; versioning qualifier and ui.sourceBuckets mechanism addressed in prior review threads.
docs/Catalog/Preferences.md Notes that ui.actions.deleteObject is off by default since 1.66; change is clear and accurate.
docs/walkthrough/working-with-elasticsearch.md Documents Graviton2 default for new deployments and includes a RI advisory note; content looks correct.
docs/CHUNKED_CHECKSUMS.md Adds CRC64/NVME experimental section with CloudFormation opt-in parameter; aligned to codebase spelling per prior thread.
docs/Catalog/Preview.md Adds AnnData (.h5ad) to binary/special format preview list; minimal, accurate change.
docs/Catalog/Qurator.md Adds Developer Tools section covering swappable models and session recordings; content is clear and accurate.
docs/walkthrough/working-with-the-catalog.md Adds 'Compare revisions' section describing the visual diff icon; content is concise and correct.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Quilt Catalog] --> B[FileBrowser.md\nUpload/Delete + Copy URI]
    A --> C[Qurator.md\nDeveloper Tools]
    A --> D[Preview.md\n.h5ad AnnData]
    A --> E[Preferences.md\ndeleteObject default-off]
    A --> F[Admin.md\nPrefix-scoped reindex API]
    A --> G[MCP-Server.md\nHeadless API Key access]
    A --> H[working-with-the-catalog.md\nVisual revision diffs]
    I[Infrastructure] --> J[working-with-elasticsearch.md\nGraviton2 default]
    I --> K[CHUNKED_CHECKSUMS.md\nCRC64/NVME opt-in]
Loading

Reviews (2): Last reviewed commit: "docs: align CRC64/NVME spelling with the..." | Re-trigger Greptile

drernie added 8 commits May 1, 2026 11:35
Add brief notes on swappable Bedrock models and session recordings,
introduced in Quilt Platform 1.62.
Add brief notes on the bucket file upload/delete actions and zero-config
package creation introduced in Quilt Platform 1.63.
Note the new diff icon for comparing package revisions, introduced in
Quilt Platform 1.64.
Add .h5ad to the preview list and note the new CRC64Checksums
CloudFormation parameter for faster packaging of S3-resident files.
Clarify in Preferences.md that ui.actions.deleteObject has been off by
default since Quilt Platform 1.66.
ES 7.10 (completed in 1.67) supports Graviton clusters; flag the
Reserved Instance caveat for stack admins considering a switch.
Add a brief Copy URI section to FileBrowser.md and note the new
Graviton2 default instance types for Elasticsearch deployments.
Note the new optional prefix field on POST /api/admin/reindex/<bucket>
introduced in Quilt Platform 1.69.
@codecov
Copy link
Copy Markdown

codecov Bot commented May 1, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 46.51%. Comparing base (735b396) to head (900e468).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4868   +/-   ##
=======================================
  Coverage   46.51%   46.51%           
=======================================
  Files         832      832           
  Lines       34116    34116           
  Branches     5828     5828           
=======================================
  Hits        15868    15868           
  Misses      16243    16243           
  Partials     2005     2005           
Flag Coverage Δ
api-python 93.14% <ø> (ø)
catalog 21.48% <ø> (ø)
lambda 96.63% <ø> (ø)
py-shared 98.18% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Comment thread docs/Catalog/FileBrowser.md Outdated
Comment thread docs/Catalog/FileBrowser.md Outdated
Comment thread docs/CHUNKED_CHECKSUMS.md Outdated
drernie added 3 commits May 1, 2026 12:01
The Connect Server's BearerAuthMiddleware passes any bearer token
through to the Registry, which routes qk_-prefixed tokens to API key
validation. This means headless / AWS-side clients can authenticate via
quilt3 API keys without completing the OAuth flow. Note both the HTTP
Authorization header and stdio QUILT_API_KEY env var paths.
- Qualify the delete-marker statement: only versioning-enabled buckets
  retain prior versions; unversioned buckets lose the object.
- Replace the misleading "no successors" disable hint with the actual
  mechanism documented in Preferences.md (ui.sourceBuckets: {}).
The code (CRC64NVME_HASH_NAME, CHECKSUM_TYPE_CRC64NVME, py-shared
ChecksumAlgorithm.CRC64NVME) and the catalog config-schema description
all use uppercase NVME. Match that here. Only the release notes used
the mixed-case NVMe form.
@drernie
Copy link
Copy Markdown
Member Author

drernie commented May 1, 2026

@greptileai rerun

@drernie drernie requested review from QuiltSimon and kevinemoore May 1, 2026 19:15
@drernie drernie enabled auto-merge May 1, 2026 19:17
@drernie drernie added this pull request to the merge queue May 1, 2026
Merged via the queue into master with commit f9290bc May 1, 2026
46 checks passed
@drernie drernie deleted the docs/release-notes-update branch May 1, 2026 20:01
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.

2 participants