@@ -512,6 +539,90 @@ release:
#
links: false
+ # Enables or disables formatting options.
+ # Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
+ # Defaults to `NEVER`.
+ #
+ formatted: ALWAYS
+
+ # The template to use for each change.
+ # Defaults to `- {{commitShortHash}} {{commitTitle}} ({{commitAuthor}})`.
+ #
+ change: '- {{commitShortHash}} {{commitTitle}}'
+
+ # The template to use for the whole changelog.
+ # Defaults is shown.
+ #
+ content: |
+ # Changelog
+
+ {{changelogChanges}
+ {{changelogContributors}}
+
+ # Path to a template file that defines the contents.
+ # Review the available
Name Templates.
+ # Defaults to `src/jreleaser/templates/changelog.tpl`.
+ #
+ contentTemplate: path/to/template/changelog.tpl
+
+ # Hide uncategorized commits.
+ # Defaults to `false`.
+ #
+ hideUncategorized: true
+
+ # A list of labels to be included.
+ # Only changes matching this list will be included.
+ # Defaults to empty.
+ #
+ includeLabels:
+ - 'issue'
+
+ # A list of labels to be excluded.
+ # Changes matching this list will be excluded.
+ # Defaults to empty.
+ #
+ excludeLabels:
+ - 'issue'
+
+ # Defines rules that apply labels to changes.
+ # Matchers are evaluated independently; the label will
+ # be set if at least one of the matchers meets the criteria.
+ #
+ labelers:
+ # The label to be applied.
+ #
+ - label: 'issue'
+
+ # Matches the text of the first commit line.
+ #
+ title: '^fix:'
+
+ # Matches the full text of the commit.
+ #
+ body: 'Fixes #'
+
+ # Groups changes by category.
+ # Defaults are shown.
+ #
+ categories:
+ - title: '🚀 Features'
+ labels:
+ - 'feature'
+ - 'enhancement'
+ - title: '🐛 Bug Fixes'
+ labels:
+ - 'bug'
+ - 'fix'
+
+ # Defines rules for replacing the generated content.
+ # Each replacer is applied in order.
+ #
+ replacers:
+ - search: '\[chore\]\s'
+ replace: ''
+ - search: '/CVE-(\d{4})-(\d+)/g'
+ replace: 'https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-$1-$2'
+
# A milestone associated with the release
#
milestone:
@@ -524,17 +635,18 @@ release:
# May define a `JRELEASER_MILESTONE_NAME` environment variable instead.
# Defaults to `{{tagName}}`.
#
- name: {{tagName}}
+ name: '{{tagName}}'
# The target branch to use.
# May define a `JRELEASER_BRANCH` environment variable instead.
# Defaults to the branch pointed by HEAD.
#
- targetCommitish: main
+ branch: main
# Marks the release as a draft.
+ # May define a `JRELEASER_DRAFT` environment variable instead.
# Defaults to `false`.
- #
+ #
draft: false
# Marks the release as prerelease.
@@ -694,6 +806,88 @@ release:
#
changelog.links = false
+ # Enables or disables formatting options.
+ # Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
+ # Defaults to `NEVER`.
+ #
+ changelog.formatted = "ALWAYS"
+
+ # The template to use for each change.
+ # Defaults to `- {{commitShortHash}} {{commitTitle}} ({{commitAuthor}})`.
+ #
+ changelog.change = "- {{commitShortHash}} {{commitTitle}}"
+
+ # The template to use for the whole changelog.
+ # Defaults is shown.
+ #
+ changelog.content = """
+ # Changelog
+
+ {{changelogChanges}
+ {{changelogContributors}}"""
+
+ # Path to a template file that defines the contents.
+ # Review the available
Name Templates.
+ # Defaults to `src/jreleaser/templates/changelog.tpl`.
+ #
+ changelog.contentTemplate = "path/to/template/changelog.tpl"
+
+ # Hide uncategorized commits.
+ # Defaults to `false`.
+ #
+ changelog.hideUncategorized = true
+
+ # A list of labels to be included.
+ # Only changes matching this list will be included.
+ # Defaults to empty.
+ #
+ changelog.includeLabels = ["issue"]
+
+ # A list of labels to be excluded.
+ # Changes matching this list will be excluded.
+ # Defaults to empty.
+ #
+ changelog.excludeLabels = ["issue"]
+
+ # Defines rules that apply labels to changes.
+ # Matchers are evaluated independently; the label will
+ # be set if at least one of the matchers meets the criteria.
+ #
+ [[release.github.changelog.labelers]]
+ # The label to be applied.
+ #
+ label = "issue"
+
+ # Matches the text of the first commit line.
+ #
+ title = "^fix:"
+
+ # Matches the full text of the commit.
+ #
+ body = "Fixes #"
+
+ # Groups changes by category.
+ # Defaults are shown.
+ #
+ [[release.github.changelog.categories]]
+ title = "🚀 Features"
+ labels = ["feature", "enhancement"]
+
+ [[release.github.changelog.categories]]
+ title = "🐛 Bug Fixes"
+ labels = ["bug", "fix"]
+
+ # Defines rules for replacing the generated content.
+ # Each replacer is applied in order.
+ #
+ [[release.github.changelog.replacers]]
+ search = "\[chore\]\s"
+ replace = ""
+
+ [[release.github.changelog.replacers]]
+ search = "/CVE-(\d{4})-(\d+)/g"
+ replace = "https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-$1-$2"
+
# A milestone associated with the release
# Close the milestone (if it exists and still open) upon release.
@@ -711,11 +905,12 @@ release:
# May define a `JRELEASER_BRANCH` environment variable instead.
# Defaults to the branch pointed by HEAD.
#
- targetCommitish = "main"
+ branch = "main"
# Marks the release as a draft.
+ # May define a `JRELEASER_DRAFT` environment variable instead.
# Defaults to `false`.
- #
+ #
draft = false
# Marks the release as prerelease.
@@ -881,7 +1076,104 @@ release:
// Create explicit markdown links for commit hashes.
// Defaults to `false`.
//
- "links": false
+ "links": false,
+
+ // Enables or disables formatting options.
+ // Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
+ // Defaults to `NEVER`.
+ //
+ "formatted": "ALWAYS",
+
+ // The template to use for each change.
+ // Defaults to `- {{commitShortHash}} {{commitTitle}} ({{commitAuthor}})`.
+ //
+ "change": "- {{commitShortHash}} {{commitTitle}}",
+
+ // The template to use for the whole changelog.
+ // Defaults is shown.
+ //
+ "content": "#Changelog\n\n{{changelogChanges}}\n{{changelogContributors}}",
+
+ // Path to a template file that defines the contents.
+ // Review the available
Name Templates.
+ // Defaults to `src/jreleaser/templates/changelog.tpl`.
+ //
+ "contentTemplate": "path/to/template/changelog.tpl",
+
+ // Hide uncategorized commits.
+ // Defaults to `false`.
+ //
+ "hideUncategorized": true,
+
+ // A list of labels to be included.
+ // Only changes matching this list will be included.
+ // Defaults to empty.
+ //
+ "includeLabels": [
+ "issue"
+ ],
+
+ // A list of labels to be excluded.
+ // Changes matching this list will be excluded.
+ // Defaults to empty.
+ //
+ "excludeLabels": [
+ "issue"
+ ],
+
+ // Defines rules that apply labels to changes.
+ // Matchers are evaluated independently; the label will
+ // be set if at least one of the matchers meets the criteria.
+ //
+ "labelers": [
+ {
+ // The label to be applied.
+ //
+ "label": "issue",
+
+ // Matches the text of the first commit line.
+ //
+ "title": "^fix:",
+
+ // Matches the full text of the commit.
+ //
+ "body": "Fixes #"
+ }
+ ],
+
+ // Groups changes by category.
+ // Defaults are shown.
+ //
+ "categories": [
+ {
+ "title": "🚀 Features",
+ "labels": [
+ "feature",
+ "enhancement"
+ ]
+ },
+ {
+ "title": "🐛 Bug Fixes",
+ "labels": [
+ "bug",
+ "fix"
+ ]
+ }
+ ],
+
+ // Defines rules for replacing the generated content.
+ // Each replacer is applied in order.
+ //
+ "replacers": [
+ {
+ "search": "\[chore\]\s",
+ "replace": ""
+ },
+ {
+ "search": "/CVE-(\d{4})-(\d+)/g",
+ "replace": "https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-$1-$2"
+ }
+ ]
},
// A milestone associated with the release
@@ -903,11 +1195,12 @@ release:
// May define a `JRELEASER_BRANCH` environment variable instead.
// Defaults to the branch pointed by HEAD.
//
- "targetCommitish": "main",
+ "branch": "main",
// Marks the release as a draft.
+ // May define a `JRELEASER_DRAFT` environment variable instead.
// Defaults to `false`.
- //
+ //
"draft": false,
// Marks the release as prerelease.
@@ -1130,6 +1423,127 @@ release:
-->
<links>false</links>
+
+ <!--
+ Enables or disables formatting options.
+ Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
+ Defaults to `NEVER`.
+
+ -->
+ <formatted>ALWAYS</formatted>
+
+ <!--
+ The template to use for each change.
+ Defaults to `- {{commitShortHash}} {{commitTitle}} ({{commitAuthor}})`.
+
+ -->
+ <change>- {{commitShortHash}} {{commitTitle}}</change>
+
+ <!--
+ The template to use for the whole changelog.
+ Defaults is shown.
+
+ -->
+ <content>
+ # Changelog
+
+ {{changelogChanges}
+ {{changelogContributors}}
+ </content>
+
+ <!--
+ Path to a template file that defines the contents.
+ Review the available
Name Templates.
+ Defaults to `src/jreleaser/templates/changelog.tpl`.
+
+ -->
+ <contentTemplate>path/to/template/changelog.tpl</contentTemplate>
+
+ <!--
+ Hide uncategorized commits.
+ Defaults to `false`.
+
+ -->
+ <hideUncategorized>true</hideUncategorized>
+
+ <!--
+ A list of labels to be included.
+ Only changes matching this list will be included.
+ Defaults to empty.
+
+ -->
+ <includeLabels>
+ <includeLabel>issue</includeLabel>
+ </includeLabels>
+
+ <!--
+ A list of labels to be excluded.
+ Changes matching this list will be excluded.
+ Defaults to empty.
+
+ -->
+ <excludeLabels>
+ <excludeLabel>issue</excludeLabel>
+ </excludeLabels>
+
+ <!--
+ Defines rules that apply labels to changes.
+ Matchers are evaluated independently; the label will
+ be set if at least one of the matchers meets the criteria.
+
+ -->
+ <labelers>
+ <labeler>
+ <!--
+ The label to be applied.
+
+ -->
+ <label>issue</label>
+
+ <!--
+ Matches the text of the first commit line.
+
+ -->
+ <title>^fix:</title>
+
+ <!--
+ Matches the full text of the commit.
+
+ -->
+ <body>Fixes #</body>
+ </labeler>
+ </labelers>
+
+ <!--
+ Groups changes by category.
+ Defaults are shown.
+
+ -->
+ <categories>
+ <category>
+ <title>🚀 Features</title>
+ <labelsAsString>feature,enhancement</labelsAsString>
+ </category>
+ <category>
+ <title>🐛 Bug Fixes</title>
+ <labelsAsString>bug,fix</labelsAsString>
+ </category>
+ </categories>
+
+ <!--
+ Defines rules for replacing the generated content.
+ Each replacer is applied in order.
+
+ -->
+ <replacers>
+ <replacer>
+ <search>\[chore\]\s</search>
+ </replacer>
+ <replacer>
+ <search>/CVE-(\d{4})-(\d+)/g</search>
+ <replace>https: cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-$1-$2</replace>
+ </replacer>
+ </replacers>
</changelog>
<!--
@@ -1160,12 +1574,13 @@ release:
Defaults to the branch pointed by HEAD.
-->
- <targetCommitish>main</targetCommitish>
+ <branch>main</branch>
<!--
Marks the release as a draft.
+ May define a `JRELEASER_DRAFT` environment variable instead.
Defaults to `false`.
-
+
-->
<draft>false</draft>
@@ -1354,6 +1769,97 @@ release:
// Defaults to `false`.
//
links = false
+
+ // Enables or disables formatting options.
+ // Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
+ // Defaults to `NEVER`.
+ //
+ formatted = 'ALWAYS'
+
+ // The template to use for each change.
+ // Defaults to `- {{commitShortHash}} {{commitTitle}} ({{commitAuthor}})`.
+ //
+ change = '- {{commitShortHash}} {{commitTitle}}'
+
+ // The template to use for the whole changelog.
+ // Defaults is shown.
+ //
+ content = '#Changelog\n\n{{changelogChanges}}\n{{changelogContributors}}'
+
+ // Path to a template file that defines the contents.
+ // Review the available
Name Templates.
+ // Defaults to `src/jreleaser/templates/changelog.tpl`.
+ //
+ contentTemplate = 'path/to/template/changelog.tpl'
+
+ // Hide uncategorized commits.
+ // Defaults to `false`.
+ //
+ hideUncategorized = true
+
+ // A list of labels to be included.
+ // Only changes matching this list will be included.
+ // Defaults to empty.
+ //
+ includeLabels = [
+ 'issue'
+ ]
+
+ // A list of labels to be excluded.
+ // Changes matching this list will be excluded.
+ // Defaults to empty.
+ //
+ excludeLabels = [
+ 'issue'
+ ]
+
+ // Defines rules that apply labels to changes.
+ // Matchers are evaluated independently; the label will
+ // be set if at least one of the matchers meets the criteria.
+ //
+ labeler {
+ // The label to be applied.
+ //
+ label = 'issue'
+
+ // Matches the text of the first commit line.
+ //
+ title = '^fix:'
+
+ // Matches the full text of the commit.
+ //
+ body = 'Fixes #'
+ }
+
+ // Groups changes by category.
+ // Defaults are shown.
+ //
+ category {
+ title = '🚀 Features'
+ labels = [
+ 'feature',
+ 'enhancement'
+ ]
+ }
+ category {
+ title = '🐛 Bug Fixes'
+ labels = [
+ 'bug',
+ 'fix'
+ ]
+ }
+
+ // Defines rules for replacing the generated content.
+ // Each replacer is applied in order.
+ //
+ replacer {
+ search = '\[chore\]\s'
+ replace = ''
+ }
+ replacer {
+ search = '/CVE-(\d{4})-(\d+)/g'
+ replace = 'https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-$1-$2'
+ }
}
// A milestone associated with the release
@@ -1375,11 +1881,12 @@ release:
// May define a `JRELEASER_BRANCH` environment variable instead.
// Defaults to the branch pointed by HEAD.
//
v
- targetCommitish = 'main'
+ branch = 'main'
// Marks the release as a draft.
+ // May define a `JRELEASER_DRAFT` environment variable instead.
// Defaults to `false`.
- //
+ //
draft = false
// Marks the release as prerelease.
@@ -1418,6 +1925,73 @@ release:
+
+
-
@@ -198,7 +198,7 @@
