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.

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

Release version 1.0.2 #61

Merged
merged 22 commits into from
Oct 3, 2021
Merged

Release version 1.0.2 #61

merged 22 commits into from
Oct 3, 2021

Conversation

jrfnl
Copy link
Collaborator

@jrfnl jrfnl commented Oct 3, 2021

Functional:

  • Confirm that the most recent PHPUnit changelogs have been checked and that the library is still feature complete for those versions supported within the PHPUnit version constraints.
  • Update the VERSION constant in the phpunitpolyfills-autoload.php file. PR Changelog for the 1.0.2 release #60
  • Composer: check if any dependencies/version constraints need updating.

Release:

  • Add changelog for the release - PR Changelog for the 1.0.2 release #60
    Verify that a release link at the bottom of the CHANGELOG.md file has been added.
  • Merge this PR.
  • Make sure all CI builds are green.
  • Tag the release (careful, GH defaults to develop!).
  • Create a release from the tag (careful, GH defaults to develop!) & copy & paste the changelog to it.
    Make sure to copy the links to the issues and the links to the GH usernames from the bottom of the changelog!
  • Close the milestone.
  • Open a new milestone for the next release.
  • If any open PRs/issues which were milestoned for the release did not make it into the release, update their milestone.

Announce:

  • Tweet about the release.

jrfnl and others added 22 commits August 9, 2021 18:40
When a `job` has builds which are allowed to `continue-on-error` and only those fail/error, the workflow will be marked as "passed" (green), but for any PR containing builds which failed, even though they are allowed to fail, the PR will still show an ❌.

This is confusing and discouraging for people.

Currently, there are two builds which are "allowed to fail":
* A build against PHP 8.1.
* A build against PHPUnit 10.

As people are starting to test against PHP 8.1, if that build would start to fail, it needs to be looked at straight away.

However, as PHPUnit 10.0 is still under heavy development and a release is still a while away, let's not let PRs be marked as failed, when that is the only build which is failing.
…ow-as-green-phpunit-10

GH Actions: selectively don't mark PRs as failed
Improve the code sample.
As of version 2.15.0 of the `shivammathur/setup-php` action for GitHub Actions, the PHPUnit Polyfills can be installed directly from this action using the `tools` key.

In that case, both this package as well as PHPUnit will be globally installed via Composer.

This commit adds an FAQ section to the readme with a little more information about how this works and how to get things running when installed like that.
README: various small updates / add FAQ about setup-php
Most notably, PHP Parallel Lint 1.3.1 has improved compatibility with PHP 8.1.

Refs:
* https://github.com/php-parallel-lint/PHP-Parallel-Lint/releases/tag/v1.3.1
... which includes PHP Parallel Lint by design, so no need to require it separately anymore.

Ref: https://github.com/Yoast/yoastcs/releases
* For camelCase object names which are not going to be changed being flagged.
* For fixtures containing test methods being flagged. Those are not the real tests.
Fix command name used to generate autoload files
PHPUnit just released version 9.5.10 and 8.5.21.

This contains a particular (IMO breaking) change:

> * PHPUnit no longer converts PHP deprecations to exceptions by default (configure `convertDeprecationsToExceptions="true"` to enable this)

Let's unpack this:

Previously (PHPUnit < 9.5.10/8.5.21), if PHPUnit would encounter a PHP native deprecation notice, it would:
1. Show a test which causes a deprecation notice to be thrown as **"errored"**,
2. Show the **first** deprecation notice it encountered and
3. PHPUnit would exit with a **non-0 exit code** (2), which will fail a CI build.

As of PHPUnit 9.5.10/8.5.21, if PHPUnit encounters a PHP native deprecation notice, it will no longer do so. Instead PHPUnit will:
1. Show a test which causes a PHP deprecation notice to be thrown as **"risky"**,
2. Show the **all** deprecation notices it encountered and
3. PHPUnit will exit with a **0 exit code**, which will show a CI build as passing.

This commit reverts PHPUnit to the previous behaviour by adding `convertDeprecationsToExceptions="true"` to the PHPUnit configuration.
The build against PHP 8.1 has been passing for a while and it should stay that way.
... but allow for the builds to fail.
…allowed-to-fail

GH Actions: adjust matrix - add PHP 8.2, PHP 8.1 not allowed to fail
The version check in the `Autoload::loadTestCase()` method could get confused if the package using this library, or a dependency of the package using this library would alias the `PHPUnit_Runner_Version`/`PHPUnit\Runner\Version` class.

As both classes contain the method we need to retrieve the version number, let's always base the loading on the available PHPUnit version number instead of the availability of either class.
Autoload: improve/stabilize version check for TestCase
Includes updating the `VERSION` constant in the `Autoload` class.
@jrfnl jrfnl added this to the 1.0.2 milestone Oct 3, 2021
@jrfnl jrfnl merged commit 1a582ab into main Oct 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants