Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Craig Boileau committed Nov 18, 2024
1 parent 1852bd6 commit c084d81
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,15 @@ Review the script source code to ensure it's safe:

https://github.com/cboileau/FWindowsUpdateReboot/blob/4eeee1f0e29e3bad1fd22c02dbe23ad78f456141/FWindowsUpdateReboot.ps1#L1-L153

## Testing
## Development

### Testing

The project includes unit tests written using Pester, the standard testing framework for PowerShell. Tests can be run locally or through GitHub Actions CI pipeline.

### Running Tests Locally
#### Running Tests Locally

#### Option 1: Using the Test Runner Script (Recommended)
##### Option 1: Using the Test Runner Script (Recommended)

1. Clone the repository:
```powershell
Expand All @@ -91,15 +93,15 @@ You can also run specific test categories from PowerShell:
.\Run-Tests.ps1 -TestType Uninstallation
```

### CI/CD
#### CI/CD

The project uses GitHub Actions to run tests automatically on:
- Every push to the main branch
- Every pull request to the main branch

Test results can be viewed in the Actions tab of the repository.

### Running Individual Test Cases
#### Running Individual Test Cases

To run specific test cases, you can use Pester's filtering:

Expand All @@ -117,7 +119,7 @@ $config.Run.Path = "Tests"
Invoke-Pester -Configuration $config
```

### Troubleshooting Tests
#### Troubleshooting Tests

If tests fail, check:
1. Pester is installed correctly
Expand Down

0 comments on commit c084d81

Please sign in to comment.