[CSR-4288] Document Playwright Last Failed action in README

[miguelangaranocurrents]

Summary

Replaces the generic TypeScript action template README with user-facing documentation for Playwright Last Failed: purpose, cache vs API (orchestration) behavior, inputs and outputs, setup steps, and a minimal workflow example. Wording uses third person / neutral voice (no you / your).

Documentation

Primary link for readers: Re-run only failed tests (GitHub Actions), plus the conceptual Re-run only failed tests guide.

Notes

• action.yml remains the source of truth for exact input names; the README defers there for metadata.
• README formatted with the repository Prettier config.
• CI: addresses Super-Linter markdown (MD029, MD013) and NATURAL_LANGUAGE (terminology) on README.md.

  

Summary by CodeRabbit

• Documentation
  • Replaced README with full docs for the Playwright Last Failed Action: overview, two operation modes (cache and orchestration), and behavior of extra Playwright flags.
  • Documented all inputs, cache-mode requirements, usage examples for CI, orchestration environment guidance, and development/run instructions.

[coderabbitai]

📝 Walkthrough

Walkthrough

README.md was completely rewritten from a generic TypeScript template to comprehensive documentation for the Playwright Last Failed GitHub Action. The new README explains the action's dual-mode operation, all configuration inputs, setup requirements, usage examples, and development instructions.

Changes

Action Documentation

Layer / File(s)	Summary
Overview and Purpose README.md	Introduction establishes the action's purpose: re-running only failed Playwright tests and restoring last-run metadata for both cache and orchestration contexts.
Operating Modes and Output Specification README.md	Detailed explanation of cache mode (default get/set steps) versus API/orchestration mode (prior run fetch), and explicit output definition for extra-pw-flags with failure/empty-restoration behavior.
Configuration, Setup, and Usage Examples README.md	Complete inputs table with defaults and environment-variable equivalents, setup instructions for dependency wiring, minimal YAML example showing cache-mode sharded test execution, and orchestration-mode CI variable guidance.
Action Metadata and Development Instructions README.md	Links to action.yml, TypeScript source file locations, npm build workflow, and updated markdown reference links.

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Title check	✅ Passed	The title directly and accurately summarizes the main change: documenting the Playwright Last Failed action in the README file.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch cursor/readme-currents-action-docs-ecd5

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 48-49: Update the phrasing "post cache step" to the hyphenated
form "post-cache step" in the README sentence ("the CLI to resolve failures via
the API). In this mode the post cache step skipped.") so the compound modifier
is hyphenated for clarity; find the exact occurrence of "post cache step" and
replace it with "post-cache step".

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4bd1f01f-2b8b-4422-97dd-cf0483f413e8

📥 Commits

Reviewing files that changed from the base of the PR and between 4062444 and f399636.

📒 Files selected for processing (1)

• README.md

[notion-workspace]

📖 Documentation improvement for last failed and or8n