Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove references to Pester tests #102

Merged
merged 1 commit into from
Jun 3, 2024
Merged

Remove references to Pester tests #102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 0 additions & 33 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,39 +92,6 @@ Note: Since WindowsToolchain uses a `.yaml` file for configuration, make sure to

The [Toolchain CI](.\.github\workflows\ci.yaml) GitHub Workflow enforces the linting rules during PR and CI.

## Testing

WindowsToolchain uses [Pester][pester] for testing the CMake files in the codebase. The tests are written for
[PowerShell Core][powershellcore] and checked into [the `Tests` folder](./Tests). To run the tests:

1. Launch a [PowerShell Core][powershellcore] prompt.

```text
pwsh
```

2. Make sure that you have [Pester][pester] installed. This only needs to be done once.

```powershell
Install-Module Pester
```

3. Import the Pester module into the PowerShell Core session:

```powershell
Import-Module Pester
```

4. Discover and run all tests:

```powershell
Invoke-Pester
```

The [Toolchain CI](.\.github\workflows\ci.yaml) GitHub Workflow requires all tests to pass during PR and CI.

[cmake-toolchains]: https://cmake.org/cmake/help/latest/manual/cmake-toolchains.7.html "CMake Toolchains"
[cmakelang]: https://cmake-format.readthedocs.io/ "cmakelang"
[pester]: https://pester.dev/ "Pester"
[powershellcore]: https://learn.microsoft.com/en-us/powershell/ "PowerShell Core"
[ewdk]: https://learn.microsoft.com/en-us/windows-hardware/drivers/develop/using-the-enterprise-wdk "Enterprise Windows Driver Kit"