Upgrade to mautic/api-library v4.0.0-beta
to fix incompatibility with psr/log
v3
#40
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR upgrades
mautic/api-library
fromv3.1.0
tov4.0.0-beta
and removes the explicit constraint ofpsr/log
v2, so the v3 can be used.This allows users who cannot downgrade to
psr/log
v2 to still be able to use this library.Important
This PR is intended to be merged and released under a
beta
pre-release tag. E.g:1.0.0-beta
or0.4.0-beta
. DO NOT release this under a stable version, otherwise it could affect existing consumers of the package.Motivation and context
Fixes #38. The solution is also discused in #39.
The problem is the following:
mautic/api-library
hasn't released a new stable version since 2022.mautic/api-library
v3.1.0 released on 2022 is incompatible withpsr/log
v3.mautic/api-library
v4.0.0-beta released on Sep 3, 2024 addresses this issue and makes the library compatible withpsr/log
v3. However, it's been 4 months since that beta version and it is unknown if a new stable version will be released soon.The proposed solution is the following:
mautic/api-library
fromv3.1.0
tov4.0.0-beta
so we can benefit from the new features and bug fixes of the new release.swisnl/laravel-mautic
asv1.0.0-beta
orv0.4.0-beta
so it can be used in the meantime untilmautic/api-library
publishes a new stable version. It must be published with abeta
pre-release version so composer doesn't use that version by default.How has this been tested?
To be frank, I haven't tested it in depth because I don't have the tools to do so. I forked the repo, installed the dependencies, made the changes and run the tests.
After that I pushed to my fork and tested in my own private company project that the package installs correctly against my own branch:
I haven't manually tested the integration of mautic because I don't have any mautic integration code to test in the first place. But I think that is out of scope of this package and it's responsibility of the
mautic/api-library
package.You can help me by skimming the diff between v3.1.0 and v4.0.0-beta and v4.0.0-beta changelog to check if you can identify any breaking change there in any method that this package uses.
Screenshots (if appropriate)
Types of changes
What types of changes does your code introduce? Put an
x
in all the boxes that apply:Checklist:
Go over all the following points, and put an
x
in all the boxes that apply.Please, please, please, don't send your pull request until all of the boxes are ticked. Once your pull request is created, it will trigger a build on our continuous integration server to make sure your tests and code style pass.
If you're unsure about any of these, don't hesitate to ask. We're here to help!