Skip to content

Latest commit

 

History

History
74 lines (53 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

74 lines (53 loc) · 2.04 KB

Contributing

composer install && ./vendor/bin/phpunit

Testing

Unit tests

To run the unit tests, install the dependencies with Composer:

$ composer install

Then run the Composer "test" script:

$ composer test

End-to-end tests

These tests are implemented with our notifier testing tool Maze Runner. This requires a recent version of Ruby to run

End to end tests are written in cucumber-style .feature files, and need Ruby-backed "steps" in order to know what to run. The tests are located in the top level features directory

Install Maze Runner using Bundler:

$ bundle install

Configure the tests with the following environment variables:

  • PHP_VERSION — the PHP version to run the tests with, e.g. "8.0". This must match one of the published PHP Docker image tags
  • SYMFONY_VERSION — the version of Symfony to run the tests against, e.g. "5". There must be a matching fixture for the specified version in the features/fixtures directory

Run Maze Runner with Bundler:

$ PHP_VERSION=8.0 SYMFONY_VERSION=5 bundle exec maze-runner

To enable additional output for debugging, set the DEBUG environment variable:

$ DEBUG=1 PHP_VERSION=8.0 SYMFONY_VERSION=5 bundle exec maze-runner

Releasing

  1. Commit all outstanding changes
  2. Bump the version in BugsnagBundle.php
  3. Update the CHANGELOG.md, and README if appropriate.
  4. Commit, tag push 
    git commit -am v1.x.x
git tag v1.x.x
git push origin master v1.x.x
  5. Update the setup guide for Symfony on docs.bugsnag.com with any new content