docs(benchling): document Referenced Entities (links) + bucketless deployments#4987
Merged
Conversation
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 Report✅ All modified and coverable lines are covered by tests. 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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
drernie
marked this pull request as ready for review
July 4, 2026 23:22
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>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
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>
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.
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.0When 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."
linksmetadata shape (type/id/name/slug), what to search on (links.name), and the rawlinks.jsonartifact.linksto the Auto-Packaging metadata list.experiment_idPackage 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:
Availability
Updated to note both features require Platform 1.71.0+ (standalone
benchling-webhookv0.18.0 / v0.19.0).Related