Skip to content

Commit bd60447

Browse files
committed
Add upgrade information
1 parent bf91eba commit bd60447

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,13 @@ It is also possible to specify the reports to be used in the `phpcs.xml.dist` fi
4141
<arg name="report-\Micheh\PhpCodeSniffer\Report\Gitlab" value="phpcs-quality-report.json"/>
4242
```
4343

44+
## Upgrade from version 1 to 2
45+
46+
The usage of this package remains the same.
47+
However, the calculation of the fingerprint has been updated and is now based on the content instead of the line number.
48+
This has the advantage that lines with violations can move up or down and GitLab will not report them as new violations.
49+
When upgrading to version 2, it is likely that all violations will show up as changed once, since all fingerprints are new.
50+
4451
## References
4552

4653
- [PHP_CodeSniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer/)

0 commit comments

Comments
 (0)