Repository navigation
docs: remove the command input from the v1 README - #84
Merged
Merged
Conversation
The deprecated `ios` input description and the WDA cache retirement notice linked to doc-detective.com/docs/..., which redirects to the docs home and loses the anchor. Point both at docs.doc-detective.com. The `create_pr_on_change` and `create_issue_on_fail` descriptions said they were only valid for the "runTests" command, but the action has no `command` input. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The README documented a `command` input (`runTests`/`runCoverage`) that action.yml never declared, and qualified two inputs with "Only valid if `command` is `runTests`". Remove both. Also make the `issue_body` default match action.yml, including the `$RUN_URL` token, and name the `record` step instead of the old `startRecording` action. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the
 |
|
Claude encountered an error —— View job I'll analyze this and get back to you. |
Promptless documentation updates
|
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
Doc fixes for the v1 line (stacked on #82). The README documented a
commandinput thataction.ymlnever declared, and two links pointed at a host that drops the path. v1 semantics (CLI 4) are unchanged.Changes (before → after)
commandsection:### command (default: runTests)withrunTests/runCoverage→ removed.commandisrunTests" oncreate_pr_on_changeandcreate_issue_on_fail(README) and "Only valid for the "runTests" command." (action.yml, same two inputs) → removed.iosinput description (action.yml) and the WDA cache retirement notice (src/iosSetup.ts, rebuiltdist/):https://doc-detective.com/docs/ci/github-action#speed-up-ios-tests-on-macos(302s to the docs home, anchor lost) →https://docs.doc-detective.com/docs/ci/github-action#speed-up-ios-tests-on-macos.issue_bodydefault:Doc Detective run failed with the following results:$RESULTS→A Doc Detective run ($RUN_URL) failed with the following results:$RESULTS, matchingaction.yml. The section now also names the$RUN_URLtoken.recordstep".The
doc-detective.github.io/github-action/...URLs inartifacts/are untouched; they're the repo's own live fixture site.Tests
src/iosSetup.test.tscase asserts the retirement notice links todocs.doc-detective.com; it failed on the old URL, then passed.npm test: 37 pass, 0 fail.npm run typecheck: clean.npm run build: thedist/index.jsdiff is the one notice string.🤖 Generated with Claude Code