[docs] Document playwrightCliVersion strict SemVer 2.0 format requirement#1265
Conversation
Document the playwrightCliVersion configuration setting and its strict SemVer 2.0 requirement, introduced in microsoft/aspire#18205. The Playwright CLI installer now validates that playwrightCliVersion contains a MAJOR.MINOR.PATCH version string before forwarding it to npm. Dist-tags (latest), ranges (>=1.0.0), and v-prefixed forms (v1.52.0) are all rejected with a descriptive error message. Add a 'Pin the Playwright CLI version' section to aspire-skills.mdx covering the configuration key, valid format, and the new error message users may see if their config value does not pass validation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
There was a problem hiding this comment.
Pull request overview
Documents the newly enforced strict SemVer (MAJOR.MINOR.PATCH) requirement for the playwrightCliVersion override used by aspire agent init, so users understand how to pin Playwright CLI versions and what error they’ll see for invalid values.
Changes:
- Adds a “Pin the Playwright CLI version” section describing
playwrightCliVersionusage inaspire.config.json. - Adds an equivalent
aspire config setexample. - Documents the strict
MAJOR.MINOR.PATCHconstraint and includes the expected validation error message.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
[docs-from-code-ci-note] CI has been retriggered multiple times and is still failing due to the current PR changes (not a transient runner issue). Please update the PR changes to fix the failing checks. |
|
We've retriggered CI multiple times, and the current failures appear tied to changes in this PR rather than a transient pipeline issue. This likely needs a fix in the PR branch before CI will pass. |
|
We've retriggered CI several times, and the current failures appear to be caused by changes in this PR rather than a transient runner issue. This likely needs updates in the PR content/code to get green checks. |
|
[docs-from-code-ci] CI has been retriggered multiple times and is still failing. This appears to be due to the current PR changes rather than a transient infrastructure issue. |
|
CI has been retriggered multiple times and is still failing for this PR (latest failures: 'CI' (attempt 8)). This likely needs changes in the PR itself rather than another rerun. |
|
This PR has had CI retriggered multiple times and is still failing on PR-specific checks. It likely needs a change in this PR to pass. |
|
[docs-from-code automation] repeated-rerun-note |
|
We've retriggered CI many times on this PR and it's still failing. At this point, the failure likely comes from changes in this PR rather than transient CI flakiness, so this probably needs a content/code fix in the PR itself. |
|
CI has failed repeatedly on this docs-from-code PR after multiple reruns, and the failures appear to be related to the changes in this PR. Please review and adjust the PR content so the checks can pass. |
|
CI has been retriggered multiple times on this PR and is still failing. The failures appear tied to the current PR changes rather than a transient runner issue, so this likely needs an update in the PR content before CI will pass. |
Documents changes from microsoft/aspire#18205 by
@mitchdenny.Targeting
release/13.5— the latest release branch onmicrosoft/aspire.dev— becauserelease/13.4(derived from the source PR base refrelease/13.4) does not exist there.Why this PR is needed
PR microsoft/aspire#18205 added strict SemVer 2.0 validation to the
playwrightCliVersionconfiguration override in the Playwright CLI installer. Previously, any string value — including npm dist-tags (latest), version ranges (>=1.0.0), or prefixed versions (v1.52.0) — was forwarded directly to npm. Starting with this fix, values that are not validMAJOR.MINOR.PATCHSemVer strings are rejected with a descriptive error message. TheplaywrightCliVersionconfiguration key was previously undocumented; this PR adds the reference that users need to understand both the setting and its format constraint.Changes
Added a new "Pin the Playwright CLI version" section to
src/frontend/src/content/docs/get-started/aspire-skills.mdx:playwrightCliVersioninaspire.config.jsonor viaaspire config setMAJOR.MINOR.PATCH)aspire agent initFiles modified
src/frontend/src/content/docs/get-started/aspire-skills.mdx— updated (new section added)