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

Add How to Run Tests on README #36

Merged
merged 7 commits into from
Oct 7, 2023
Merged

Add How to Run Tests on README #36

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d7f7bf3
Add running unit-tests
matriphe Oct 7, 2023
8db70e0
Add running unit-tests on GHA
matriphe Oct 7, 2023
ebdafe4
Add runner info
matriphe Oct 7, 2023
9304811
Merge branch 'master' into add-test-command-makefile
matriphe Oct 7, 2023
c714779
Update OS
matriphe Oct 7, 2023
a0e28a0
Update ubuntu
matriphe Oct 7, 2023
73ff2dc
Add GHA title
matriphe Oct 7, 2023
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
30 changes: 30 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,36 @@ Larinfo
+--------------------+------------------------------------------+
```

## Running Tests

To run the unit tests, execute this following command.

```shell
vendor/bin/phpunit --group unit
```

### GitHub Actions

On the GitHub Actions, the tests run on the respective operating system, which are `ubuntu`, `macos`, and `windows` when a pull request is made.

To run the tests on [Ubuntu 20.04 LTS (Focal Fossa)](https://github.com/actions/runner-images/blob/23ff0d746804fc3c0ac7f961f2fbca953824c775/images/linux/Ubuntu2004-Readme.md) and [Ubuntu 22.04 LTS (Jammy Jellyfish)](https://github.com/actions/runner-images/blob/23ff0d746804fc3c0ac7f961f2fbca953824c775/images/linux/Ubuntu2204-Readme.md), run this following command.

```shell
vendor/bin/phpunit --group ubuntu
```

To run the tests on [macOS Monterey (12)](https://github.com/actions/runner-images/blob/23ff0d746804fc3c0ac7f961f2fbca953824c775/images/macos/macos-12-Readme.md) and [macOS Ventura (13)](https://github.com/actions/runner-images/blob/23ff0d746804fc3c0ac7f961f2fbca953824c775/images/macos/macos-13-Readme.md), run this following command.

```shell
vendor/bin/phpunit --group macos
```

To run the tests on [Windows Server 2019](https://github.com/actions/runner-images/blob/23ff0d746804fc3c0ac7f961f2fbca953824c775/images/win/Windows2019-Readme.md) and [Windows Server 2022](https://github.com/actions/runner-images/blob/23ff0d746804fc3c0ac7f961f2fbca953824c775/images/win/Windows2022-Readme.md), run this following command.

```shell
vendor/bin/phpunit --group windows
```

## License

Please see [License File](LICENSE.md) for more information.