Skip to content

Commit 6a27ce6

Browse files
committed
Initial configuration documentation.
1 parent 0161236 commit 6a27ce6

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

docs/02-Configuration.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Configuration
2+
3+
You may configure various options within `php-semver-checker` to make them more to your liking. In order to do so, you have to create a JSON file which will be passed to `php-semver-checker` using the `--config myconfig.json` or `-c myconfig.json` flag.
4+
5+
```json
6+
{
7+
"level": {
8+
"mapping": {
9+
"V001": "PATCH"
10+
}
11+
}
12+
}
13+
```
14+
15+
## Configuration sections
16+
17+
The following describes every section of the configuration in more details in order to allow you to customize `php-semver-checker` to your liking.
18+
19+
### Level
20+
21+
#### Mapping
22+
23+
Every item in the mapping section presents a rule that you may override. The key is the ruleset code and the value is the semantic version level you want the rule to generate when it is detected.
24+
25+
```json
26+
{
27+
"level": {
28+
"mapping": {
29+
"V001": "PATCH",
30+
"V006": "MAJOR",
31+
}
32+
}
33+
}
34+
```

0 commit comments

Comments
 (0)