Skip to content

Latest commit

聽

History

History
296 lines (265 loc) 路 8.54 KB

changelog.adoc

File metadata and controls

296 lines (265 loc) 路 8.54 KB
Raw
<!--
  Changelog customization.
  icon:dot-circle[]
-->
<changelog>
<!--
   Disables or enables the changelog.
  defaults to `true`.
  icon:dot-circle[]
-->
<enabled>true</enabled>
<!--
  Sorts commits in ascending (oldest first) or descending (newer first).
  Supported values are>`ASC`, `DESC`.
  Defaults to `DESC`.
  icon:dot-circle[]
-->
<sort>DESC</sort>
<!--
  Path to an external file that contains the changelog, read as is.
  May be a relative path to the configuration file or an absolute path.
  If unspecified, JReleaser will automatically calculate the changelog.
  icon:dot-circle[]
-->
<external>path/to/changelog.md</external>
<!--
  Create explicit markdown links for commit hashes.
  Defaults to `false`.
  icon:dot-circle[]
-->
<links>false</links>
<!--
  Whether to skip merge commits from the generated changelog
  Defaults to `false`.
  icon:dot-circle[]
-->
<skipMergeCommits>false</skipMergeCommits>
<!--
  Enables or disables formatting options.
  Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
  Defaults to `NEVER`.
  icon:dot-circle[]
-->
<formatted>ALWAYS</formatted>
<!--
  Preconfigured changelog options.
  Supported values are [`gitmoji`, `conventional-commits`].
  Requires `formatted` to be enabled.
  Defaults to empty.
  icon:dot-circle[]
-->
<preset>gitmoji</preset>
<!--
  The template to use for each change.
  Defaults to `- {{commitShortHash}} {{commitTitle}} ({{commitAuthor}})`.
  icon:dot-circle[] icon:file-alt[]
-->
<format>- {{commitShortHash}} {{commitTitle}}</format>
<!--
  The template to use for category titles.
  Defaults to `## {{categoryTitle}}`.
  icon:dot-circle[] icon:file-alt[]
-->
<categoryTitleFormat>### {{categoryTitle}}</categoryTitleFormat>
<!--
  The template to use for the contributors section.
  Defaults to `## Contributors`.
  icon:dot-circle[] icon:file-alt[]
-->
<contributorsTitleFormat>### Contributors'</contributorsTitleFormat>
<!--
  The template to use for the whole changelog.
  Default is shown.
  icon:dot-circle[] icon:file-alt[]
-->
<content>
  # Changelog
  {{changelogChanges}}
  {{changelogContributors}}
</content>
<!--
  Path to a template file that defines the contents.
  Review the available xref:reference:name-templates.adoc[].
  Defaults to `src/jreleaser/templates/changelog.tpl`.
  icon:dot-circle[]
-->
<contentTemplate>path/to/template/changelog.tpl</contentTemplate>
<!--
  icon:dot-circle[]
-->
<append>
  <!--
    Enables appending to an existing changelog file.
    Defaults to `false`.
    icon:dot-circle[]
  -->
  <enabled>true</enabled>
<!--
  The title for the partial changelog.
  Default is shown.
  icon:dot-circle[] icon:file-alt[]
-->
<title>## [{{tagName}}]</title>
<!--
  Path to the full changelog file where appends will occur.
  Default is shown.
  icon:dot-circle[] icon:file-alt[]
-->
<target>CHANGELOG.md</target>
<!--
  The template to use for the partial changelog.
  Default is shown.
  icon:dot-circle[] icon:file-alt[]
-->
<content>
  {{changelogTitle}}
  {{changelogContent}}
</content>
  <!--
    Path to a template file that defines the contents.
    Review the available xref:reference:name-templates.adoc[].
    Defaults to `src/jreleaser/templates/append-changelog.tpl`.
    icon:dot-circle[]
  -->
  <contentTemplate>path/to/template/append-changelog.tpl</contentTemplate>
</append>
<!--
  icon:dot-circle[]
-->
<contributors>
  <!--
    Enables the contributors block.
    Defaults to `true`.
    icon:dot-circle[]
  -->
  <enabled>true</enabled>
  <!--
    The template to use for each contributor.
    Defaults to `{{contributorName}}`.
    icon:dot-circle[] icon:file-alt[]
  -->
  <format>- {{contributorName}} ({{contributorUsernameAsLink}})</format>
</contributors>
<!--
  icon:dot-circle[]
-->
<hide>
  <!--
    Hide uncategorized commits.
    Defaults to `false`.
    icon:dot-circle[]
  -->
  <uncategorized>true</uncategorized>
<!--
  Hide matching categories.
  Entries must exactly match category keys defined below.
  Defaults to empty.
  icon:dot-circle[]
-->
<categories>
  <category>merge</category>
</categories>
  <!--
    Hide matching contributor names.
    Value may be plain text or regex.
    Defaults to empty.
    icon:dot-circle[]
  -->
  <contributors>
    <contributor>[bot]</contributor>
  </contributors>
</hide>
<!--
  A list of labels to be included.
  Only changes matching this list will be included.
  Defaults to empty.
  icon:dot-circle[]
-->
<includeLabels>
  <includeLabel>issue</includeLabel>
</includeLabels>
<!--
  A list of labels to be excluded.
  Changes matching this list will be excluded.
  Defaults to empty.
  icon:dot-circle[]
-->
<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.
  icon:dot-circle[]
-->
<labelers>
  <labeler>
    <!--
      The label to be applied.
      icon:exclamation-triangle[]
    -->
    <label>issue</label>
<!--
  Matches the text of the first commit line.
  Value may be plain text or regex.
  Use `regex:` as prefix to indicate a regex.
  icon:dot-circle[]
-->
<title>regex:fix:</title>
<!--
  Matches the full text of the commit.
  Value may be plain text or regex.
  Use `regex:` as prefix to indicate a regex.
  icon:dot-circle[]
-->
<body>Fixes #</body>
    <!--
      Priority when sorting.
      Defaults to `null`
      icon:dot-circle[]
    -->
    <order>1</order>
  </labeler>
</labelers>
<!--
  Groups changes by category.
  Defaults are shown.
  icon:dot-circle[]
-->
<categories>
  <category>
    <!-- Used for rendering -->
    <title>馃殌 Features</title>
    <!-- Used for identifying the category -->
    <key>features</key>
    <labels>feature,enhancement</labels>
    <order>1</order>
  </category>
  <category>
    <title>馃悰 Bug Fixes</title>
    <key>fixes</key>
    <!--
      You may override the format per category.
    -->
    <format>- {{commitShortHash}} {{commitBody}}</format>
    <labels>bug,fix</labels>
    <order>2</order>
  </category>
</categories>
  <!--
    Defines rules for replacing the generated content.
    Each replacer is applied in order.
    icon:dot-circle[] icon:file-alt[]
  -->
  <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>