Skip to content

Commit 4635ac3

Browse files
committed
release: v0.13.0
1 parent caff2b8 commit 4635ac3

File tree

3 files changed

+30
-18
lines changed

3 files changed

+30
-18
lines changed

ChangeLog.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,34 @@ The default texts are defined like this:
1111
semver {
1212
changeLogTexts {
1313
headerTexts = mutableMapOf(
14-
"fix" to "### Bug Fixes \uD83D\uDC1E",
15-
"feat" to "### New Features \uD83C\uDF89",
16-
"test" to "### Tests ✅",
17-
"docs" to "### Documentation \uD83D\uDCD6",
18-
"deps" to "### Dependency Updates \uD83D\uDE80",
19-
"build" to "### Build \uD83D\uDC18 & CI \uFE0F",
20-
"ci" to "### Build \uD83D\uDC18 & CI \uFE0F",
21-
"chore" to "### Chores \uD83D\uDD27",
22-
"perf" to "### Performance Enhancements",
23-
"refactor" to "### Refactorings \uD83D\uDE9C"
14+
"fix" to "### \uD83D\uDC1E Bug Fixes",
15+
"feat" to "### \uD83C\uDF89 New Features",
16+
"test" to "### ✅ Tests",
17+
"docs" to "### \uD83D\uDCD6 Documentation",
18+
"deps" to "### \uD83D\uDE80 Dependency Updates",
19+
"build" to "### \uD83D\uDC18 Build & \uFE0F CI",
20+
"ci" to "### \uD83D\uDC18 Build & \uFE0F CI",
21+
"chore" to "### \uD83D\uDD27 Chores",
22+
"perf" to "### Performance Enhancements",
23+
"refactor" to "### \uD83D\uDE9C Refactorings"
2424
)
2525
header = "## What's Changed" // Set your custom header text
26-
breakingChange = "### Breaking Changes 🛠" // Set your custom breaking change text
27-
otherChange = "### Other Changes \uD83D\uDCA1" // Set your custom other change text
26+
breakingChange = "### 🛠 Breaking Changes" // Set your custom breaking change text
27+
otherChange = "### \uD83D\uDCA1 Other Changes" // Set your custom other change text
2828
}
2929
}
3030
```
3131

32+
Note: this is a change from how it looked before. If you want the emojis last like configure the plugin like this:
33+
```kotlin
34+
import git.semver.plugin.changelog.EmojisLastHeaderTexts
35+
36+
semver {
37+
changeLogTexts = EmojisLastHeaderTexts
38+
}
39+
```
40+
41+
3242
### Plain header text
3343

3444
You can configure the header texts to be plain text instead of markdown

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -315,15 +315,17 @@ a shallow copy.
315315
```
316316

317317

318-
## Limitations
318+
## Version 0.x.x
319+
Breaking changes for version 0.x.x do not automatically increase the major version. If you want to increase the major
320+
version, create a release commit manually and set the desired version number e.g.
319321

320-
### Version 0.x.x
321-
There is currently no special handling for version 0.x.x. If you make breaking changes and want to preserve the 0.x.x
322-
version create a release commit yourself and set the number as desired e.g.
323322
```
324-
git commit -m "release: 0.1.2" --allow-empty
323+
git commit -m "release: 1.0.0" --allow-empty
325324
```
326325

326+
327+
## Limitations
328+
327329
### Reverts
328330
The plugin does not handle commits reverting previous commits and referring to the reverted commit in the commit message.
329331
Set the version to the correct version after reverting as in the example above.

src/test/kotlin/git/semver/plugin/gradle/GitSemverPluginExtensionTest.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,6 @@ class GitSemverPluginExtensionTest {
6969
assertThat(actual)
7070
.contains("# Test Change Log")
7171
.contains("## Test")
72-
.contains("- Test Commit (John Doe) (John Doe <john.doe@example.com>)")
72+
.contains("- Test Commit (John Doe) (John Doe [john.doe@example.com])")
7373
}
7474
}

0 commit comments

Comments
 (0)