Skip to content

Commit f1f44ff

Browse files
committed
Prepare release
1 parent 669dc28 commit f1f44ff

3 files changed

Lines changed: 43 additions & 10 deletions

File tree

LICENSE

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2121
SOFTWARE.
22-
23-
---
24-
25-
Third-Party Notice
26-
27-
This project depends on Playwright, an open-source project by Microsoft,
28-
licensed under Apache License 2.0 (https://github.com/microsoft/playwright/blob/main/LICENSE).
29-
"Playwright" is a trademark of Microsoft. This project is independent and not
30-
affiliated with or endorsed by Microsoft.

NOTICE

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Third-Party Notice
2+
3+
This project depends on Playwright, an open-source project by Microsoft,
4+
licensed under Apache License 2.0 (https://github.com/microsoft/playwright/blob/main/LICENSE).
5+
"Playwright" is a trademark of Microsoft. This project is independent and not
6+
affiliated with or endorsed by Microsoft.

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
# Setup Playwright (for PHP)
1111

1212
Sets up the runner for [Playwright for PHP](https://playwright-php.dev):
13-
- install `@playwright` JS library globally
13+
- install Playwright library globally
1414
- download the browser binaries (default: Chrome)
1515

1616
## Usage
@@ -36,6 +36,36 @@ jobs:
3636
- run: vendor/bin/phpunit
3737
```
3838
39+
## Examples
40+
41+
### Install multiple browsers
42+
```yaml
43+
- uses: playwright-php/setup-playwright@v1
44+
with:
45+
browsers: '["chromium","firefox"]'
46+
```
47+
48+
### Reuse cached browser downloads
49+
```yaml
50+
- uses: actions/cache@v4
51+
with:
52+
path: ~/.cache/ms-playwright
53+
key: browsers-${{ runner.os }}
54+
55+
- uses: playwright-php/setup-playwright@v1
56+
with:
57+
browsers-path: ~/.cache/ms-playwright
58+
```
59+
60+
### Pin the Playwright CLI version and skip deps
61+
```yaml
62+
- uses: playwright-php/setup-playwright@v1
63+
with:
64+
playwright-version: '1.48.2'
65+
browsers: webkit
66+
with-deps: false
67+
```
68+
3969
## Outputs
4070
4171
The action exposes two outputs:
@@ -52,6 +82,12 @@ The action exposes two outputs:
5282
| `with-deps` | `auto` | `true`, `false`, `auto` | `auto` appends Playwright's `--with-deps` flag on Linux runners. |
5383
| `browsers-path` | | Directory path | Exports `PLAYWRIGHT_BROWSERS_PATH` so downloads land in your cache. Leave blank for Playwright defaults (`~/.cache/ms-playwright`, `%LOCALAPPDATA%\ms-playwright`, etc.) |
5484

85+
## Testing the action
86+
87+
1. Trigger `.github/workflows/test.yml` via `workflow_dispatch` to exercise the action on hosted runners.
88+
2. Run the same workflow with [`act`](https://github.com/nektos/act) to catch issues locally before pushing.
89+
3. In a scratch repo, reference the action with `uses: ./` so every commit is validated before tagging a Marketplace release.
90+
5591
## License
5692

5793
This package is released by the [Playwright PHP](https://playwright-php.dev)

0 commit comments

Comments
 (0)