Skip to content

Commit f49e7c7

Browse files
committed
Add section linking to php-semver-checker-git
1 parent 934dd8e commit f49e7c7

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,14 @@ PHP Semantic Versioning Checker is a console/library which allows you to inspect
1111

1212
After the inspection is completed, you are given a list of changes that have occurred between the two changesets following [Semantic Versioning 2.0.0](https://semver.org/). For each of these changes, the level of the change (MAJOR, MINOR, PATCH) will be given, as well as the location of the change (file and line number) and a reason as to why this level change is suggested.
1313

14+
## For continuous integration
15+
16+
If you'd like to use `php-semver-checker` in your CI pipeline, we recommend you look at
17+
[`php-semver-checker-git`](https://github.com/tomzx/php-semver-checker-git) which integrates with Git and will compare
18+
your latest changes with the latest Git tag of your repository.
19+
1420
## Semantic Versioning 2.0.0 Overview
21+
1522
Given a version number MAJOR.MINOR.PATCH, increment the:
1623

1724
* MAJOR version when you make incompatible API changes,
@@ -29,6 +36,7 @@ As this is still an alpha package, it is not suggested to include `php-semver-ch
2936
See the example section for examples of how to use the tool.
3037

3138
### Building `php-semver-checker.phar`
39+
3240
First, make sure you have [box](https://github.com/box-project/box2) installed. Then, in the base directory, you can run the following command which will generate the `php-semver-checker.phar` file.
3341

3442
```
@@ -135,6 +143,7 @@ Time: 1.43 seconds, Memory: 5.123 MB
135143

136144
## Contributing
137145
### Adding new rules
146+
138147
* Add the rules to the `docs/Ruleset.md` document
139148
* Run `php scripts/extract-rules-from-ruleset.php` to generate an up to date array to paste in the `Configuration/LevelMapping.php` file
140149
* Update the documentation @ https://github.com/tomzx/php-semver-checker-docs

0 commit comments

Comments
 (0)