From 8a0958df51d3f46a3e8d281a4d4a9f70da966f69 Mon Sep 17 00:00:00 2001 From: Dave Tryon <45672944+DaveTryon@users.noreply.github.com> Date: Thu, 30 Jun 2022 15:19:42 -0700 Subject: [PATCH] chore: Add docs about virus scanner exclusions (#5696) --- README.md | 1 + docs/virus-scanner-exclusions.md | 23 +++++++++++++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 docs/virus-scanner-exclusions.md diff --git a/README.md b/README.md index 5c1a56aee..cda958144 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,7 @@ Please visit our [FAQ](https://accessibilityinsights.io/docs/en/web/reference/fa All contributions are welcome! To get started, please read through our [CONTRIBUTING](./CONTRIBUTING.md) guidelines for this project. After that, see: - [Git branch setup](./docs/git-branch-setup.md) +- [Virus scanner exclusions](./docs/virus-scanner-exclusions.md) - [Building Accessibility Insights for Web](./docs/building-web.md) - [Building Accessibility Insights for Android (Unified)](./docs/building-unified.md) diff --git a/docs/virus-scanner-exclusions.md b/docs/virus-scanner-exclusions.md new file mode 100644 index 000000000..71f33088b --- /dev/null +++ b/docs/virus-scanner-exclusions.md @@ -0,0 +1,23 @@ + + +## Virus scanner exclusions + +When running locally, especially when running end-to-end (E2E) tests, virus scanners have been known to have a significant impact on execution time. In some extreme cases, E2E tests have been known to fail as a result of having virus scanners running against files that are built by the repo and used during the tests. To prevent this, you may wish to exclude the entire repo--or possibly just the `drop` folder--from virus scanning. The specifics of how to do this will vary between virus scanners, between operating systems, and possibly between different versions of the same virus scanner. + +### Microsoft Defender (Windows only) +The following steps allow you to exclude a folder and all its descendants from Microsoft Defender. These instructions have been validated on both Windows 10 and Windows 11: +- From the start menu, run **Windows Security** +- Enter the **Virus & threat protection** tab +- Under **Virus & threat protection settings**, click **Manage settings** +- Under **Exclusions**, click **Add or remove exclusions** +- If prompted for permissions, grant permissions +- Click **Add an exclusion** +- Select **Folder** as the exclusion type +- Specify the folder to ignore--all descendants of this folder will be ignored. Note that the folder must exist when it is added as an exclusion. Take this into account if you choose to exclude just the `drop` folder +- Click **Select folder** + +### Other antivirus products +Please consult your antivirus product's documentation.