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.

Sign up for GitHub

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

Jump to bottom

Support baseline configuration #737

Merged
merged 6 commits into from
Feb 5, 2025
Merged

Support baseline configuration #737

merged 6 commits into from
Feb 5, 2025

Conversation

lcobucci
Copy link
Contributor

This allows users to set a list of regexes to filter known BC-breaks from detected changes.

lcobucci
lcobucci commented Feb 15, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
lcobucci
lcobucci commented Feb 15, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
@lcobucci
Copy link
Contributor Author

@Nyholm although this uses a different name/format, it could be used to simplify https://github.com/Nyholm/roave-bc-check-docker 👍

@Ocramius
Copy link
Member

I'll need to ponder on this: my preference would be to have either an XSD or a JSON schema, at least, and use those as documentation too 🤔

@Ocramius Ocramius added this to the 8.4.0 milestone Feb 15, 2023
@lcobucci
Copy link
Contributor Author

I'll need to ponder on this: my preference would be to have either an XSD or a JSON schema, at least, and use those as documentation too 🤔

I totally understand. I didn't want to introduce new dependencies to the project (I did implicitly add ext-json, though).

Up to you, mate!

lcobucci
lcobucci commented Feb 16, 2023
View reviewed changes
src/Baseline.php Outdated Show resolved Hide resolved
src/Baseline.php Show resolved Hide resolved
@lcobucci lcobucci force-pushed the support-baseline-configuration branch from a157044 to 0680f22 Compare February 21, 2023 19:14
@lcobucci lcobucci mentioned this pull request Feb 21, 2023
Closed
asgrim
asgrim reviewed Feb 22, 2023
View reviewed changes
Copy link
Member

@asgrim asgrim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lcobucci I'm loving this change, and it indeed formalises things that @Nyholm had done before (which I've used for a project too!) - really nice feature, looking forward to getting this shaped up ❤️

src/Baseline.php Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
src/Command/AssertBackwardsCompatible.php Outdated Show resolved Hide resolved
src/Command/Configuration.php Outdated Show resolved Hide resolved
src/Command/Configuration.php Outdated Show resolved Hide resolved
@lcobucci lcobucci force-pushed the support-baseline-configuration branch from 0680f22 to c251f5a Compare February 23, 2023 22:23
@lcobucci lcobucci force-pushed the support-baseline-configuration branch 2 times, most recently from f208c41 to f9cb116 Compare February 26, 2023 21:08
@lcobucci lcobucci requested review from asgrim and Ocramius and removed request for asgrim and Ocramius February 26, 2023 21:09
@Ocramius
Copy link
Member

@lcobucci sorry, this is on my plate, didn't get to it though :(

@Ocramius Ocramius self-assigned this Feb 26, 2023
@lcobucci
Copy link
Contributor Author

@lcobucci sorry, this is on my plate, didn't get to it though :(

Wow, the GH ui went crazy there... Just wanted to ask a review from you two (not to spam both).

No worries, we do what we can, whenever we can!

@lcobucci
Copy link
Contributor Author

That segfault seems to be unrelated... let me know if you need help with understanding why it's happening

asgrim
asgrim reviewed Feb 27, 2023
View reviewed changes
Copy link
Member

@asgrim asgrim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No idea what the segfault is for, but it's happening consistently 😬

README.md Outdated Show resolved Hide resolved
resources/schema.xsd Outdated Show resolved Hide resolved
@lcobucci lcobucci force-pushed the support-baseline-configuration branch from f9cb116 to c39d76d Compare February 28, 2023 19:34
@lcobucci lcobucci mentioned this pull request Feb 28, 2023
Closed
Ocramius
Ocramius approved these changes Mar 1, 2023
View reviewed changes
Copy link
Member

@Ocramius Ocramius left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good!

My only last concern is reducing public API as a start, perhaps, but I also don't mind bumping major version, if the API needs to change due to different directions taken in future 💪

README.md Outdated Show resolved Hide resolved
resources/schema.xsd Outdated Show resolved Hide resolved
src/Command/DetermineConfigurationFromFilesystem.php Show resolved Hide resolved
src/Command/DetermineConfigurationFromFilesystem.php Show resolved Hide resolved
src/Configuration/Configuration.php Show resolved Hide resolved
src/Configuration/InvalidConfigurationStructure.php Show resolved Hide resolved
src/Configuration/ParseXmlConfigurationFile.php Show resolved Hide resolved
@lcobucci lcobucci force-pushed the support-baseline-configuration branch from c39d76d to aeac38f Compare March 1, 2023 21:03
@lcobucci
Copy link
Contributor Author

lcobucci commented Mar 1, 2023

All done 👍

@lcobucci lcobucci force-pushed the support-baseline-configuration branch 3 times, most recently from 4dab6f3 to e19974d Compare March 1, 2023 22:49
@lcobucci lcobucci mentioned this pull request Mar 2, 2023
Merged
Ocramius
Ocramius approved these changes Mar 2, 2023
View reviewed changes
Copy link
Member

@Ocramius Ocramius left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pristine job as usual, thanks @lcobucci! 💎

@Ocramius
Copy link
Member

Ocramius commented Mar 2, 2023

Hmm, the segfault part still requires a PHPUnit upgrade: checking that first then.

@lcobucci lcobucci force-pushed the support-baseline-configuration branch from e19974d to cdeca27 Compare March 2, 2023 22:50
asgrim
asgrim reviewed Mar 14, 2023
View reviewed changes
composer.json Outdated Show resolved Hide resolved
@Ocramius Ocramius mentioned this pull request Mar 29, 2023
Open
@Ocramius Ocramius removed this from the 8.4.0 milestone Nov 25, 2023
@lcobucci lcobucci force-pushed the support-baseline-configuration branch from cdeca27 to de08e5a Compare February 4, 2025 20:22
@lcobucci lcobucci changed the base branch from 8.4.x to 8.11.x February 4, 2025 20:22
@Ocramius Ocramius added this to the 8.11.0 milestone Feb 4, 2025
@lcobucci lcobucci force-pushed the support-baseline-configuration branch from de08e5a to 302de15 Compare February 5, 2025 19:25
@lcobucci
Implement regex-based baseline for changes
279d7f4 
This adds (lazy) filtering capabilities to detected changes.

Signed-off-by: Luís Cobucci <lcobucci@gmail.com>
@lcobucci
Parse and apply baseline from configuration
8734285 
This integrates the changes filter into the backward compatibility check
command, parsing the configuration file prior to any process to ease the
integration of new properties.

Signed-off-by: Luís Cobucci <lcobucci@gmail.com>
@lcobucci
Make configuration parsing more flexible
b29a141 
This moves responsibilities around and introduces abstractions to
support different file formats with less effort.

Signed-off-by: Luís Cobucci <lcobucci@gmail.com>
@lcobucci lcobucci force-pushed the support-baseline-configuration branch from 302de15 to 53966ae Compare February 5, 2025 19:33
@lcobucci
Implement XML configuration parser
024306b 
This ships a parser and the expected schema to ease the validation of
XML documents.

Signed-off-by: Luís Cobucci <lcobucci@gmail.com>
@lcobucci
Make XML the default configuration format
f824a0b 
Signed-off-by: Luís Cobucci <lcobucci@gmail.com>
@lcobucci
Remove unused JSON parser
f6bea18 
Signed-off-by: Luís Cobucci <lcobucci@gmail.com>
@lcobucci lcobucci force-pushed the support-baseline-configuration branch from 53966ae to f6bea18 Compare February 5, 2025 19:51
@lcobucci
Copy link
Contributor Author

lcobucci commented Feb 5, 2025

@Ocramius alright, this should finally be good to go too.

I've updated the XSD to enforce a #whateva# pattern, which should be sufficient for pretty much all use cases.

@Ocramius
Copy link
Member

Ocramius commented Feb 5, 2025

🚢!

@Ocramius Ocramius merged commit 3afc875 into Roave:8.11.x Feb 5, 2025
13 checks passed
@lcobucci lcobucci deleted the support-baseline-configuration branch February 5, 2025 20:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@asgrim asgrim asgrim approved these changes

@azjezz azjezz azjezz left review comments

@Ocramius Ocramius Ocramius approved these changes

Assignees

@Ocramius Ocramius

Labels
enhancement
Projects
None yet
Milestone
8.11.0
Development

Successfully merging this pull request may close these issues.
4 participants
@lcobucci @Ocramius @asgrim @azjezz