Skip to content
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

Jump to bottom

changelog does not include body or footer information #746

Open
jlanzarotta opened this issue May 11, 2023 · 1 comment
Open

changelog does not include body or footer information #746

jlanzarotta opened this issue May 11, 2023 · 1 comment
Labels
type: bug

Comments

@jlanzarotta
Copy link

Description

When generating a changelog where commits contain conventional commits, the body (the extended commit information) along with the footer information (ticket references information, etc.) is not written to the output file.

Steps to reproduce

cz changelog

Current behavior

Commits that have body and footer information, have this information missing from the changelog.

Desired behavior

Commits that have body and footer information, would have this information shown in the changelog.

Screenshots

No response

Environment

  • commitizen version 3.2.2
@AGiantSquid
Copy link

AGiantSquid commented Jun 4, 2024 •
edited
Loading

It is possible to add the body and footer information by customizing the config_parser regex and the template.

For example, set up a cz.yaml file with something like this:

---
commitizen:
  customize:
    commit_parser: ^((?P<change_type>feat|fix|refactor|perf|BREAKING CHANGE)(?:\((?P<scope>[^()\r\n]*)\)|\()?(?P<breaking>!)?|\w+!):\s(?P<subject>[^\n]*)(?P<body>(?:\n(?!Refs:|:\s#)[^\n]*)*)(?:\n(?P<footer>(?:Refs:[\s\S]*)?))?$
  name: cz_customize
  tag_format: v$version
  update_changelog_on_bump: true
  version_provider: npm
  version_scheme: semver
  template: CHANGELOG.md.j2

The commit_parser will parse your commit, and make the capture groups available to your formatter. In the regex string above, we're getting a section after the subject and labeling it "body", and getting any content that starts "Refs: " and labeling it footer.

You can then create a template CHANGELOG.md.j2 like this:

{% for entry in tree %}
{% set entry_title -%}
{{ entry.version }}{% if entry.date %} ({{ entry.date }}){% endif -%}
{%- endset %}

{{ entry_title }}
{{ "=" * entry_title|length }}

{% for change_key, changes in entry.changes.items() %}
{% if change_key %}
{{ change_key }}
{{ "-" * change_key|length }}
{% endif %}

{% for change in changes %}
{% if change.footer %}
{% set ticket = change.footer.split('#')[1] %}
{% endif %}
{% set ticket_link = "[[" + ticket + "](https://blah.atlassian.net/browse/" + ticket + ")] " if ticket else ""  %}
{% set commit_link = "[" + change.sha1[:7] + "](" + change.sha1 + ")" %}
{% set scope = "**" + change.scope + "**: " if change.scope else ""  %}
- {{ ticket_link }}{{ scope }}{{ change.subject }} {{commit_link}}
{% if change.body %}
{% set lines = change.body.split('\n') %}
{% for line in lines %}
{% set stripped_line = line.strip() -%}
{% if stripped_line.startswith('-') %}
    {{ stripped_line }}
{% elif stripped_line %}
    - {{ stripped_line }}
{% endif %}
{% endfor %}
{% endif %}
{% endfor %}

{% endfor %}
{% endfor %}

Which will use the capture groups subject body and footer from the commit_parser is the cz.yaml.

Adjust the regex according to your commit formatting:

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type: bug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jlanzarotta @AGiantSquid