Skip to content

Commit 784da8a

Browse files
committed
docs: 📝 update --preset section
1 parent 6763eaa commit 784da8a

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,14 +127,18 @@ As an example, suppose you're using GitLab, rather than GitHub, you might modify
127127
"executor": "@jscutlery/semver:version",
128128
"options": {
129129
"preset": {
130+
"name": "angular",
130131
"commitUrlFormat": "{{host}}/{{owner}}/{{repository}}/commit/{{hash}}",
131-
"compareUrlFormat": "{{host}}/{{owner}}/{{repository}}/compare/{{previousTag}}...{{currentTag}}"
132+
"compareUrlFormat": "{{host}}/{{owner}}/{{repository}}/compare/{{previousTag}}...{{currentTag}}",
132133
"issueUrlFormat": "{{host}}/{{owner}}/{{repository}}/issues/{{id}}"
133134
}
134135
}
135136
}
136137
```
137138

139+
See [conventional-changelog-config-spec](https://github.com/conventional-changelog/conventional-changelog-config-spec) for available
140+
configuration options.
141+
138142
#### Version calculation
139143

140144
This package is **tag-based**, which means it never reads the `package.json` to retrieve the current version. Instead, it looks for a tag matching the `--tagPrefix` (i.e `demo-x.y.z`). Then, if no tag is found it fallbacks to `0.0.0`, and calculates the initial version based on all changes since the first commit. In the other case, if there are matching tags, it retrieves the last one and calculates the new version from it.

0 commit comments

Comments
 (0)