Support baseline configuration by lcobucci · Pull Request #737 · Roave/BackwardCompatibilityCheck

lcobucci · 2023-02-15T22:59:47Z

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

README.md

lcobucci · 2023-02-15T23:06:13Z

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

Ocramius · 2023-02-15T23:12:55Z

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 🤔

src/Command/AssertBackwardsCompatible.php

lcobucci · 2023-02-16T06:06:52Z

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!

src/Baseline.php

asgrim

@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

README.md

src/Command/AssertBackwardsCompatible.php

src/Command/Configuration.php

test/unit/Command/ConfigurationTest.php

Ocramius · 2023-02-26T22:45:56Z

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

lcobucci · 2023-02-26T23:20:16Z

@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 · 2023-02-27T08:05:51Z

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

asgrim

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

README.md

resources/schema.xsd

Ocramius

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

resources/schema.xsd

src/Command/DetermineConfigurationFromFilesystem.php

src/Configuration/Configuration.php

src/Configuration/InvalidConfigurationStructure.php

src/Configuration/ParseXmlConfigurationFile.php

lcobucci · 2023-03-01T21:03:24Z

All done 👍

Ocramius

Pristine job as usual, thanks @lcobucci! 💎

Ocramius · 2023-03-02T10:50:11Z

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

composer.json

test/e2e/Command/AssertBackwardsCompatibleTest.php

This adds (lazy) filtering capabilities to detected changes. Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

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>

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

This ships a parser and the expected schema to ease the validation of XML documents. Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

lcobucci · 2025-02-05T19:53:28Z

@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 · 2025-02-05T20:03:44Z

🚢!

lcobucci commented Feb 15, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

lcobucci commented Feb 15, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

Ocramius added the enhancement label Feb 15, 2023

Ocramius added this to the 8.4.0 milestone Feb 15, 2023

Ocramius reviewed Feb 15, 2023

View reviewed changes

src/Command/AssertBackwardsCompatible.php Show resolved Hide resolved

lcobucci commented Feb 16, 2023

View reviewed changes

src/Baseline.php Outdated Show resolved Hide resolved

src/Baseline.php Show resolved Hide resolved

lcobucci force-pushed the support-baseline-configuration branch from a157044 to 0680f22 Compare February 21, 2023 19:14

lcobucci mentioned this pull request Feb 21, 2023

Do not count "skipped" changes as BC breaking #735

Closed

asgrim reviewed Feb 22, 2023

View reviewed changes

lcobucci force-pushed the support-baseline-configuration branch from 0680f22 to c251f5a Compare February 23, 2023 22:23

lcobucci commented Feb 23, 2023

View reviewed changes

test/unit/Command/ConfigurationTest.php Show resolved Hide resolved

lcobucci force-pushed the support-baseline-configuration branch 2 times, most recently from f208c41 to f9cb116 Compare February 26, 2023 21:08

lcobucci requested review from Ocramius and asgrim and removed request for Ocramius and asgrim February 26, 2023 21:09

Ocramius self-assigned this Feb 26, 2023

asgrim reviewed Feb 27, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

resources/schema.xsd Show resolved Hide resolved

lcobucci force-pushed the support-baseline-configuration branch from f9cb116 to c39d76d Compare February 28, 2023 19:34

lcobucci mentioned this pull request Feb 28, 2023

SEGFAULTs consistently happening on CI #740

Closed

Ocramius approved these changes Mar 1, 2023

View reviewed changes

lcobucci force-pushed the support-baseline-configuration branch from c39d76d to aeac38f Compare March 1, 2023 21:03

lcobucci force-pushed the support-baseline-configuration branch 3 times, most recently from 4dab6f3 to e19974d Compare March 1, 2023 22:49

lcobucci mentioned this pull request Mar 2, 2023

Upgrade to PHPUnit v10 #741

Merged

Ocramius approved these changes Mar 2, 2023

View reviewed changes

lcobucci force-pushed the support-baseline-configuration branch from e19974d to cdeca27 Compare March 2, 2023 22:50

asgrim reviewed Mar 14, 2023

View reviewed changes

composer.json Outdated Show resolved Hide resolved

azjezz reviewed Mar 19, 2023

View reviewed changes

test/e2e/Command/AssertBackwardsCompatibleTest.php Show resolved Hide resolved

Ocramius mentioned this pull request Mar 29, 2023

unrecognized node type PhpParser\Node\Expr\FuncCall #743

Open

Ocramius removed this from the 8.4.0 milestone Nov 25, 2023

lcobucci force-pushed the support-baseline-configuration branch from cdeca27 to de08e5a Compare February 4, 2025 20:22

lcobucci changed the base branch from 8.4.x to 8.11.x February 4, 2025 20:22

Ocramius added this to the 8.11.0 milestone Feb 4, 2025

lcobucci force-pushed the support-baseline-configuration branch from de08e5a to 302de15 Compare February 5, 2025 19:25

lcobucci added 3 commits February 5, 2025 20:33

Implement regex-based baseline for changes

279d7f4

This adds (lazy) filtering capabilities to detected changes. Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

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>

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 force-pushed the support-baseline-configuration branch from 302de15 to 53966ae Compare February 5, 2025 19:33

lcobucci added 3 commits February 5, 2025 20:51

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>

Make XML the default configuration format

f824a0b

Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

Remove unused JSON parser

f6bea18

Signed-off-by: Luís Cobucci <lcobucci@gmail.com>

lcobucci force-pushed the support-baseline-configuration branch from 53966ae to f6bea18 Compare February 5, 2025 19:51

Ocramius merged commit 3afc875 into Roave:8.11.x Feb 5, 2025
13 checks passed

lcobucci deleted the support-baseline-configuration branch February 5, 2025 20:05

Comments

Conversation

lcobucci commented Feb 15, 2023

Uh oh!

Uh oh!

Uh oh!

lcobucci commented Feb 15, 2023

Uh oh!

Ocramius commented Feb 15, 2023

Uh oh!

Uh oh!

lcobucci commented Feb 16, 2023

Uh oh!

Uh oh!

Uh oh!

asgrim left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Ocramius commented Feb 26, 2023

Uh oh!

lcobucci commented Feb 26, 2023

Uh oh!

lcobucci commented Feb 27, 2023

Uh oh!

asgrim left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Ocramius left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lcobucci commented Mar 1, 2023

Uh oh!

Ocramius left a comment

Choose a reason for hiding this comment

Uh oh!

Ocramius commented Mar 2, 2023

Uh oh!

Uh oh!

Uh oh!

lcobucci commented Feb 5, 2025

Uh oh!

Ocramius commented Feb 5, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants