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

Updates for latest SodiumCompat 1.x and allow for SodiumCompat 2.x #46

Merged
merged 2 commits into from
Apr 24, 2024

Conversation

jrfnl
Copy link
Member

@jrfnl jrfnl commented Apr 24, 2024

GH Actions: update the workflow to allow for Sodium Compat 2.x

Sodium Compat has tagged new releases in the 1.x series, but has now also released a 2.0 version, which has a PHP 8.1 minimum.

The GH Actions workflow for this package tests that the ruleset doesn't throw any errors on the polyfills repos themselves. So, to allow for both the 1.x as well as the 2.x branches, some changes to the workflows are required.

This commit sorts this out by:

  • Adding extra builds to make sure that the SodiumCompat ruleset is tested against both Sodium Compat 1.x as well as 2.x.
  • Making sure that the tests against the 2.x branch sets the PHPCompatibility testVersion to 8.1-.

Refs:

Sodium Compat ruleset: prevent triggering on the polyfill

This is for a new class which was added to Sodium_Compat 1.x.

Sodium Compat has tagged new releases in the 1.x series, but has now also released a 2.0 version, which has a PHP 8.1 minimum.

The GH Actions workflow for this package tests that the ruleset doesn't throw any errors on the polyfills repos themselves. So, to allow for both the 1.x as well as the 2.x branches, some changes to the workflows are required.

This commit sorts this out by:
* Adding extra builds to make sure that the SodiumCompat ruleset is tested against both Sodium Compat 1.x as well as 2.x.
* Making sure that the tests against the 2.x branch sets the PHPCompatibility `testVersion` to `8.1-`.

Refs:
* https://github.com/paragonie/sodium_compat/releases
* https://paragonie.com/blog/2024/04/release-sodium-compat-v2-and-future-our-polyfill-libraries
This is for a new class which was added to Sodium_Compat 1.x.
@jrfnl jrfnl added this to the 1.x Next milestone Apr 24, 2024
@jrfnl
Copy link
Member Author

jrfnl commented Apr 24, 2024

As the jobs/names of CI jobs have been updated, the branch protection needs an update too. I've just done this. Other open PRs will need a rebase once this PR has been merged.

Also note: the CI failing against PHPCompatibility 10 is expected and not a concern until we're close to the PHPCompatibility 10 release.

@jrfnl jrfnl merged commit ede80c8 into master Apr 24, 2024
6 of 8 checks passed
@jrfnl jrfnl deleted the feature/ghactions-update-for-sodium-2 branch April 24, 2024 15:08
@jrfnl
Copy link
Member Author

jrfnl commented Apr 24, 2024

Note: as this PR adds an ignore for some code in the latest version of the 1.x SodiumCompat package, a new release is warranted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant