forked from facebook/docusaurus
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://github.com/dithizac000/docusaurus
- Loading branch information
Showing
336 changed files
with
8,839 additions
and
6,537 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| name: Argos CI | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| pull_request: | ||
| branches: [main] | ||
|
|
||
| jobs: | ||
| take-screenshots: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Check out repository code | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| # A minimal fetch-depth of 2 is required | ||
| # to automatically detect branch in @argos-ci/cli | ||
| fetch-depth: 2 | ||
|
|
||
| - name: Use Node.js | ||
| uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: 16 | ||
|
|
||
| - name: Install dependencies | ||
| run: yarn install --frozen-lockfile | ||
|
|
||
| - name: Install Playwright browsers | ||
| run: npx playwright install --with-deps | ||
|
|
||
| - name: Build website fast | ||
| run: yarn build:website:fast | ||
|
|
||
| - name: Take Argos screenshots | ||
| run: yarn argos:screenshot | ||
|
|
||
| - name: Upload Argos screenshots | ||
| continue-on-error: true | ||
| run: yarn argos:upload |
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
|
|
||
| /screenshots/ | ||
| /test-results/ | ||
| /playwright-report/ | ||
| /playwright/.cache/ |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # Argos visual regression tests | ||
|
|
||
| We use [Argos CI](https://argos-ci.com) to detect visual regressions on Docusaurus. | ||
|
|
||
| This workspace can be run manually, but is generally run through the [Argos GitHub Action](../.github/workflows/argos.yml). | ||
|
|
||
| The workflow execute those following steps: | ||
|
|
||
| - Build the website locally with `yarn build:website:fast` | ||
| - Start the website server with `yarn serve:website` on [http://localhost:3000](http://localhost:3000) | ||
| - Take screenshots of all pages found in `sitemap.xml` with Playwright | ||
| - Upload all screenshots to [Argos CI](https://argos-ci.com) | ||
|
|
||
| This workflow runs for `main` and PR branches, and add a commit status to each PR with a visual diff that we can easily inspect. | ||
|
|
||
| --- | ||
|
|
||
| Some additional capabilities: | ||
|
|
||
| - Use [./tests/screenshot.spec.ts](./tests/screenshot.spec.ts) to customize the screenshots we take, eventually filter out some useless sitemap pages like versioned docs | ||
| - Use [./tests/screenshot.css](./tests/screenshot.css) to hide flaky CSS elements: iframe, video, gif... |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| { | ||
| "name": "argos", | ||
| "version": "3.0.0-alpha.0", | ||
| "description": "Argos visual diff tests", | ||
| "license": "MIT", | ||
| "private": true, | ||
| "scripts": { | ||
| "screenshot": "playwright test", | ||
| "upload": "npx @argos-ci/cli upload ./screenshots", | ||
| "report": "playwright show-report" | ||
| }, | ||
| "dependencies": { | ||
| "@argos-ci/cli": "^0.4.4", | ||
| "@argos-ci/playwright": "^0.0.4", | ||
| "@playwright/test": "^1.30.0", | ||
| "cheerio": "^1.0.0-rc.12" | ||
| } | ||
| } |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| /** | ||
| * Copyright (c) Facebook, Inc. and its affiliates. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| */ | ||
|
|
||
| import {devices} from '@playwright/test'; | ||
| import type {PlaywrightTestConfig} from '@playwright/test'; | ||
|
|
||
| /** | ||
| * See https://playwright.dev/docs/test-configuration. | ||
| */ | ||
| const config: PlaywrightTestConfig = { | ||
| testDir: './tests', | ||
|
|
||
| // Run website production built | ||
| // Need to run "yarn website:build:fast" before | ||
| webServer: { | ||
| cwd: '..', | ||
| port: 3000, | ||
| command: 'yarn serve:website', | ||
| }, | ||
|
|
||
| // Browsers: only Chrome for now | ||
| projects: [ | ||
| { | ||
| name: 'chromium', | ||
| use: { | ||
| ...devices['Desktop Chrome'], | ||
| }, | ||
| }, | ||
| ], | ||
| }; | ||
|
|
||
| export default config; |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| /** | ||
| * Copyright (c) Facebook, Inc. and its affiliates. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| */ | ||
|
|
||
| /* | ||
| Things to hide in Argos screenshots because it's source of flakiness | ||
| */ | ||
| iframe, | ||
| article.yt-lite, | ||
| .theme-last-updated, | ||
| .avatar__photo, | ||
| img[src$='.gif'], | ||
| h2#using-jsx-markup ~ div > div[class*='browserWindowBody']:has(b), | ||
| [class*='playgroundPreview'] { | ||
| visibility: hidden; | ||
| } |
Oops, something went wrong.