Skip to content

chore(chnagelog): Rename message to description #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jmongard merged 1 commit into from
Jun 11, 2026
Merged

chore(chnagelog): Rename message to description #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/main/kotlin/git/semver/plugin/changelog/ChangeLogFormatter.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ data class ChangeLogFormatter(
companion object {
private const val SCOPE = "Scope"
private const val TYPE = "Type"
private const val MESSAGE = "Message"
private const val DESCRIPTION = "Description"
}

fun formatLog(changeLog: List<Commit>, settings: SemverSettings, changeLogTexts: ChangeLogTexts): String {
Expand Down Expand Up @@ -57,7 +57,7 @@ data class ChangeLogFormatter(
isBreakingChange,
it.groupValue(TYPE),
it.groupValue(SCOPE),
it.groupValue(MESSAGE)
it.groupValue(DESCRIPTION)
)
} ?: CommitInfo(commits, text, isBreakingChange)
}
Expand All @@ -70,7 +70,7 @@ data class ChangeLogFormatter(
val isBreaking: Boolean,
val type: String? = null,
val scope: String? = null,
val message: String? = null
val description: String? = null
)

class Context {
Expand Down
4 changes: 2 additions & 2 deletions src/main/kotlin/git/semver/plugin/changelog/ChangeLogTexts.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,11 +63,11 @@ open class ChangeLogTexts(

var sortByText: Boolean = true

var changeLogPattern: String = "(?m)^(?<Type>\\w+)(?:\\((?<Scope>[^()]+)\\))?!?:\\s*(?<Message>.*)$"
var changeLogPattern: String = "(?m)^(?<Type>\\w+)(?:\\((?<Scope>[^()]+)\\))?!?:\\s*(?<Description>.*)$"


var headerFormat: (ChangeLogFormatter.CommitInfo) -> String = { commitInfo ->
(commitInfo.message ?: commitInfo.text).lineSequence().first()
(commitInfo.description ?: commitInfo.text).lineSequence().first()
}
var fullHeaderFormat: (ChangeLogFormatter.CommitInfo) -> String = { commitInfo ->
commitInfo.text.lineSequence().first()
Expand Down
Loading