https://github.com/php-actions/example-phpunit

An example project that uses php-actions/phpunit
https://github.com/php-actions/example-phpunit

Last synced: about 1 month ago
JSON representation

An example project that uses php-actions/phpunit

• Host: GitHub
• URL: https://github.com/php-actions/example-phpunit
• Owner: php-actions
• Created: 2020-08-11T14:11:19.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-16T11:02:37.000Z (8 months ago)
• Last Synced: 2024-04-16T14:26:07.060Z (8 months ago)
• Language: PHP
• Homepage:
• Size: 124 KB
• Stars: 24
• Watchers: 3
• Forks: 51
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
An example project that uses [php-actions/phpunit][action-link]

===

This is a trivial project that holds only simple example functionality: a greeter that can greet you by name.

Check out the [**Actions tab** in the Github repository][actions-tab] to see the past actions workflows and their outputs.

There are unit tests stored within the `test` directory, along with a `phpunit.xml`.

The file at `.github/workflows/ci.yml` shows how to use [php-actions/phpunit][action-link] - take note of the `uses: php-actions/phpunit@v9` line.

Versions of PHPUnit and all options are available to configure. Please see the [php-actions/phpunit documentation][action-link] for more information! 

Functionality

-------------

There are two classes in this example project; `Greeter` and `EnvGreeter`, in the `src/` directory, which are tested in the `test/` directory.

The `Greeter` has a function, `greet()` which takes an optional name. Without providing a name, the Greeter will return "Hello!", otherwise it will include the provided name, like "Hello, Example!".

The `EnvGreeter` extends `Greeter` and provides a new function, `greetFromEnv()`, which takes the name of an environment variable to load the name from.

The GitHub Action tests are executed in the [`ci.yml` file](https://github.com/php-actions/example-phpunit/blob/e1db6474eec4dc75526042f9cf5dab2bf8f163f9/.github/workflows/ci.yml#L14-L21) where the TEST_NAME environment variable is declared, along with any other PHPUnit configuration.

Click the [Actions tab](https://github.com/php-actions/example-phpunit/actions) at the top of this repository to view the latest test runs.

*** 

If you found this repository helpful, please consider [sponsoring the developer][sponsor].

[action-link]: https://github.com/php-actions/phpunit

[actions-tab]: https://github.com/php-actions/example-phpunit/actions

[sponsor]: https://github.com/sponsors/g105b