Skip to content

docs(benchling): document Referenced Entities (links) + bucketless deployments#4987

Merged
drernie merged 8 commits into
docs-1.71.0from
docs/benchling-entity-links
Jul 15, 2026
Merged

docs(benchling): document Referenced Entities (links) + bucketless deployments#4987
drernie merged 8 commits into
docs-1.71.0from
docs/benchling-entity-links

Conversation

@drernie

@drernie drernie commented Jun 16, 2026

Copy link
Copy Markdown
Member

What

Documents the two new Benchling-webhook capabilities shipping in Quilt Platform 1.71.0, in docs/examples/benchling.md.

1. Referenced Entities (links) — v0.18.0

When packaging a notebook entry, the webhook discovers the Benchling objects that entry references and records them in searchable package metadata by human-readable name. Headline use case: "show me every experiment that referenced QB-2743.1."

  • New Referenced Entities section: the links metadata shape (type/id/name/slug), what to search on (links.name), and the raw links.json artifact.
  • Adds links to the Auto-Packaging metadata list.
  • Contrasts it with the existing manual experiment_id Package Linking so the two "linking" concepts don't blur.

2. Bucketless Deployments — v0.19.0

The package bucket is now optional. New Bucketless Deployments section covering:

  • Setup and secret creation omit the package bucket.
  • Entry/canvas events skip default per-entry package creation.
  • Linked-package discovery spans all package-view buckets in the stack (via Athena), preserving the source bucket when browsing from a canvas.

Availability

Updated to note both features require Platform 1.71.0+ (standalone benchling-webhook v0.18.0 / v0.19.0).

Related

Adds a "Referenced Entities" section to the Benchling integration guide
covering the v0.18.0 `links` feature: each notebook entry's referenced
Benchling objects are recorded in searchable package metadata by their
human-readable name (e.g. find every experiment that referenced QB-2743.1).

Also adds `links` to the Auto-Packaging metadata list and contrasts it with
the manual experiment_id Package Linking mechanism.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@codecov

codecov Bot commented Jun 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 49.52%. Comparing base (52c1289) to head (063d956).

Additional details and impacted files
@@             Coverage Diff              @@
##           docs-1.71.0    #4987   +/-   ##
============================================
  Coverage        49.52%   49.52%           
============================================
  Files              844      844           
  Lines            34426    34426           
  Branches          5830     5830           
============================================
  Hits             17049    17049           
  Misses           15493    15493           
  Partials          1884     1884           
Flag Coverage Δ
api-python 93.14% <ø> (ø)
catalog 25.19% <ø> (ø)
lambda 97.09% <ø> (ø)
py-shared 98.02% <ø> (ø)

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

☔ View full report in Codecov by Harness.
📢 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.

@drernie
drernie marked this pull request as ready for review July 4, 2026 23:22
Comment thread docs/examples/benchling.md
drernie and others added 3 commits July 4, 2026 17:12
The surrounding prose describes links as an array of referenced entity
objects, but the JSON code block showed a bare object. Wrap the example
in an array so the code matches the documentation.

Co-Authored-By: Claude <noreply@anthropic.com>
Add a Bucketless Deployments section covering the optional package
bucket (v0.19.0): setup/secret creation omit the bucket, entry/canvas
events skip default package creation, and linked-package discovery spans
all package-view buckets via Athena. Update Availability to note both
Referenced Entities and bucketless deployments require Platform 1.70.0.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@drernie drernie changed the title docs(benchling): document searchable referenced entities (links) docs(benchling): document Referenced Entities (links) + bucketless deployments Jul 11, 2026
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@drernie
drernie changed the base branch from master to docs-1.71.0 July 15, 2026 17:50
drernie added 2 commits July 15, 2026 11:39
1.71.0 independently added a short '### Searching by Referenced
Entities' section describing the same feature this PR's fuller
'### Referenced Entities' section already covers (links schema,
type/id/name/slug fields, links.json). Git's line-based merge
didn't conflict since they occupy different line ranges, but they
documented the same capability twice. Keep this PR's fuller version.
@drernie
drernie merged commit e23f65e into docs-1.71.0 Jul 15, 2026
44 checks passed
@drernie
drernie deleted the docs/benchling-entity-links branch July 15, 2026 22:05
nl0 added a commit that referenced this pull request Jul 16, 2026
…chling docs

- Installation.md: remove the in-place network 1.0->2.0 migration note per
  review (single-customer scope).
- benchling.md: replace the ad-hoc Referenced-Entities/optional-bucket prose
  with the official #4987 version (detailed links array + Bucketless
  Deployments) that landed on the branch.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.

1 participant