chore(docs): Rework CI docs #31988
chore(docs): Rework CI docs #31988
Conversation
docs/src/ci-intro.md
Outdated
| with: | ||
| name: playwright-report | ||
| path: playwright-report/ | ||
| retention-days: 30 | ||
| ``` | ||
|
|
||
| ### On push/pull_request | ||
| If this doesn't make sense to you, give GitHub's [Understanding GitHub Actions](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions) guide a read. Looking at the list of steps in `jobs.test.steps`, you can see that the workflow performs these steps: |
There was a problem hiding this comment.
same comment as below regarding wording if this doesnt make sense
| @@ -25,22 +23,18 @@ When [installing Playwright](./intro.md) using the [VS Code extension](./getting | |||
|
|
|||
| Playwright tests can be ran on any CI provider. In this section we will cover running tests on GitHub using GitHub actions. If you would like to see how to configure other CI providers check out our detailed doc on Continuous Integration. | |||
|
|
|||
| To add a [GitHub Actions](https://docs.github.com/en/actions) file first create `.github/workflows` folder and inside it add a `playwright.yml` file containing the example code below so that your tests will run on each push and pull request for the main/master branch. | |||
|
|
|||
| #### You will learn | |||
| * langs: python, java, csharp | |||
There was a problem hiding this comment.
just double check this makes sense for all langs except js or it should also have js?
There was a problem hiding this comment.
Yes this is intended. There's a separate "You will learn" list for JS that has different contents in https://github.com/microsoft/playwright/pull/31988/files#diff-49b43d48c93c3dc274299a0604e3a7c8ea1ed9891a230f3125e9992867d2ed3fL13-L14.
Signed-off-by: Simon Knott <info@simonknott.de>
docs/src/ci.md
Outdated
| ## CI configurations | ||
|
|
||
| ### GitHub Actions | ||
|
|
||
| The [Command line tools](./browsers#install-system-dependencies) can be used to install all operating system dependencies on GitHub Actions. |
There was a problem hiding this comment.
I don't understand who this sentence is addressed to under GitHub Actions title. Previously the user was redirected to our comprehensive getting started guide which is where they should start. If they know that stuff, they likely now how to install browsers and deps already. I'd revert Check out our [GitHub Actions](ci-intro.md) guide here or maybe just drop this paragraph.
There was a problem hiding this comment.
This PR moves the comprehensive github actions guide into here, so ci-intro.md is just an intro. I agree that the paragraph reads weird though, max was saying the same in #31988 (comment). I'll move the paragraph above the heading and reword.
Co-authored-by: Yury Semikhatsky <yurys@chromium.org> Signed-off-by: Simon Knott <info@simonknott.de>
Test results for "tests 1"5 flaky29658 passed, 711 skipped Merge workflow run. |
This PR moves around some of our CI docs. It moves the GitHub actions docs from
ci-intro.mdtoci.md, reducesci-intro.mdto be an introduction, adds a mention of Sharding to the best practices, and adds a section on--only-changedcalled "Fail-Fast". Each of those changes is a separate commit, to make this a little easier to review. If we find any of those to commits to be contentious, i'll pull them out into individual PRs.While rolling this to playwright.dev, we'll also make the following changes to its sidebar:
ci.mddocument from the "Integrations" section to the "Playwright Test" section