docs: align pilot workflow with Assay 1.22#44
Open
Haserjian wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the pilot documentation workflow snippets to consistently install the released assay-ai==1.22.0, avoiding stale git-commit pins or loose minimum-version constraints in the “proof-carrying PR” quickstart and starter workflow.
Changes:
- Replace
assay-ai @ git+https://...@13db5bawithassay-ai==1.22.0in the pilot starter workflow. - Replace
assay-ai>=1.10.1withassay-ai==1.22.0in the pilot starter workflow. - Align the same two install locations in the quickstart snippet to
assay-ai==1.22.0.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/pilot/starter-workflow.yml | Pins both “Install assay” steps to assay-ai==1.22.0 for consistent CI behavior. |
| docs/pilot/quickstart.md | Pins both pip install lines in the example workflow to assay-ai==1.22.0 to match the intended pilot setup. |
| with: | ||
| python-version: "3.12" | ||
| - run: pip install "assay-ai @ git+https://github.com/Haserjian/assay.git@13db5ba" | ||
| - run: pip install "assay-ai==1.22.0" |
There was a problem hiding this comment.
PR description/test plan suggest the pilot docs are now fully unified on assay-ai==1.22.0, but docs/pilot/failure-modes.md still includes an example pin (pip install "assay-ai==1.10.1"). Consider updating that snippet to 1.22.0 as well, or clarifying in the PR description/test plan that only quickstart + starter-workflow are in scope.
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.
Summary
Unify the
pip install assay-aiclauses indocs/pilot/quickstart.mdanddocs/pilot/starter-workflow.ymlto the same pin,assay-ai==1.22.0. Scope is intentionally limited to these two files — the two surfaces a pilot team copy-pastes into their own repo.docs/pilot/quickstart.md:67"assay-ai @ git+https://github.com/Haserjian/assay.git@13db5ba""assay-ai==1.22.0"docs/pilot/quickstart.md:86"assay-ai>=1.10.1""assay-ai==1.22.0"docs/pilot/starter-workflow.yml:53"assay-ai @ git+https://github.com/Haserjian/assay.git@13db5ba""assay-ai==1.22.0"docs/pilot/starter-workflow.yml:82"assay-ai>=1.10.1""assay-ai==1.22.0"Motivation
A pilot team copying
docs/pilot/starter-workflow.ymltoday gets one job installing an old git-commit pin and another installing>=1.10.1, neither of which is the released 1.22.0.docs/pilot/outreach.md:68-69points readers at both files, so the stale pins actively propagate through every pilot invitation. Quickstart had been partially fixed earlier; starter-workflow was the remaining gap.Scope notes
docs/pilot/failure-modes.md:64still shows"assay-ai==1.10.1"inside a troubleshooting example block (### "pip install assay-ai failed"). That's an illustrative example of "pin a version if PyPI is flaky" rather than the pilot's actual install instruction, so it's intentionally out of scope for this PR. A follow-up can bump that example for consistency if wanted.docs/pilot/outreach.md) doesn't mention specific versions and doesn't need to change — its links now resolve to coherent files.Related
Companion branch
ops/public-coherence-pass-2026-04-09touched adjacent surfaces earlier. This PR is the focused quickstart + starter-workflow slice; reviewer can decide whether to land this first or roll into that branch.Test plan
grep -n "assay-ai" docs/pilot/quickstart.md docs/pilot/starter-workflow.ymlreturns onlyassay-ai==1.22.0docs/pilot/outreach.md:68-69) still resolve🤖 Generated with Claude Code