how to handle the jinja template in `cliff.toml` when using `cookiecutter` #818

pplmx · 2024-08-26T05:23:44Z

pplmx
Aug 26, 2024

Question

Reproduce

cookiecutter -c feat_auto_release_in_boilerplate gh:x-pt/template --directory template/py

The whole code is here

Error

Here is my cliff.toml as cookiecutter template file:

cliff.toml

# git-cliff ~ default configuration file
# https://git-cliff.org/docs/configuration
#
# Lines starting with "#" are comments.
# Configuration options are organized into tables and keys.
# See documentation for more information on available options.

[remote.github]
owner = "{{ cookiecutter.github_username }}"
repo = "{{ cookiecutter.project_slug }}"

[changelog]
# template for the changelog footer
header = """
# Changelog\n
All notable changes to this project will be documented in this file.\n
"""
{% raw %}
# template for the changelog body
# https://keats.github.io/tera/docs/#introduction
body = """
{%- macro remote_url() -%}
  https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
{%- endmacro -%}

{% macro print_commit(commit) -%}
    - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
        {% if commit.breaking %}[**breaking**] {% endif %}\
        {{ commit.message | upper_first }} - \
        ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\
{% endmacro -%}

{% if version %}\
    {% if previous.version %}\
        ## [{{ version | trim_start_matches(pat="v") }}]\
          ({{ self::remote_url() }}/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }}
    {% else %}\
        ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
    {% endif %}\
{% else %}\
    ## [unreleased]
{% endif %}\

{% for group, commits in commits | group_by(attribute="group") %}
    ### {{ group | striptags | trim | upper_first }}
    {% for commit in commits
    | filter(attribute="scope")
    | sort(attribute="scope") %}
        {{ self::print_commit(commit=commit) }}
    {%- endfor -%}
    {% raw %}\n{% endraw %}\
    {%- for commit in commits %}
        {%- if not commit.scope -%}
            {{ self::print_commit(commit=commit) }}
        {% endif -%}
    {% endfor -%}
{% endfor -%}
{%- if github -%}
{% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %}
  ## New Contributors ❤️
{% endif %}\
{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %}
  * @{{ contributor.username }} made their first contribution
    {%- if contributor.pr_number %} in \
      [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \
    {%- endif %}
{%- endfor -%}
{%- endif %}
{% raw %}\n{% endraw -%}
"""
{% endraw %}
# template for the changelog footer
footer = """
<!-- generated by git-cliff -->
"""
# remove the leading and trailing s
trim = true
# postprocessors
postprocessors = [
    { pattern = '<REPO>', replace = "https://github.com/{{cookiecutter.__gh_slug}}" }, # replace repository URL
]

[git]
# parse the commits based on https://www.conventionalcommits.org
conventional_commits = true
# filter out the commits that are not conventional
filter_unconventional = true
# process each line of a commit as an individual commit
split_commits = false
# regex for preprocessing the commit messages
commit_preprocessors = [
  # Replace issue numbers
  { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
  # Check spelling of the commit with https://github.com/crate-ci/typos
  # If the spelling is incorrect, it will be automatically fixed.
  #{ pattern = '.*', replace_command = 'typos --write-changes -' },
]
# regex for parsing and grouping commits
commit_parsers = [
  { message = "^feat", group = "<!-- 0 -->🚀 Features" },
  { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
  { message = "^doc", group = "<!-- 3 -->📚 Documentation" },
  { message = "^perf", group = "<!-- 4 -->⚡ Performance" },
  { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
  { message = "^style", group = "<!-- 5 -->🎨 Styling" },
  { message = "^test", group = "<!-- 6 -->🧪 Testing" },
  { message = "^chore\\(release\\): prepare for", skip = true },
  { message = "^chore\\(release-bot\\): prepare for", skip = true },
  { message = "^chore: bump version to", skip = true },
  { message = "^chore\\(deps.*\\)", skip = true },
  { message = "^chore\\(pr\\)", skip = true },
  { message = "^chore\\(pull\\)", skip = true },
  { message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
  { body = ".*security", group = "<!-- 8 -->🛡️ Security" },
  { message = "^revert", group = "<!-- 9 -->◀️ Revert" },
]
# protect breaking changes from being skipped due to matching a skipping commit_parser
protect_breaking_commits = false
# filter out the commits that are not matched by commit parsers
filter_commits = false
# regex for matching git tags
# tag_pattern = "v[0-9].*"
# regex for skipping tags
# skip_tags = ""
# regex for ignoring tags
# ignore_tags = ""
# sort the tags topologically
topo_order = false
# sort the commits inside sections by oldest/newest order
sort_commits = "newest"
# limit the number of commits included in the changelog.
# limit_commits = 42

It will throw this error:

console log

cookiecutter template/template/py
  [1/8] Enter your project name (My Awesome Project):
  [2/8] Generated project identifier (slug) (my-awesome-project):
  [3/8] Generated package/module name (my_awesome_project):
  [4/8] Brief project description (A nice python project):
  [5/8] Author's full name (Firstname Lastname):
  [6/8] Author's email address ([email protected]):
  [7/8] GitHub username or organization (your-org-or-username):
  [8/8] python_version (3.10):
Traceback (most recent call last):
  File "/Users/skynet/.local/bin/cookiecutter", line 8, in <module>
    sys.exit(main())
             ^^^^^^
  File "/Users/skynet/.local/share/uv/tools/cookiecutter/lib/python3.12/site-packages/click/core.py", line 1157, in __call__
    return self.main(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/skynet/.local/share/uv/tools/cookiecutter/lib/python3.12/site-packages/click/core.py", line 1078, in main
    rv = self.invoke(ctx)
         ^^^^^^^^^^^^^^^^
  File "/Users/skynet/.local/share/uv/tools/cookiecutter/lib/python3.12/site-packages/click/core.py", line 1434, in invoke
    return ctx.invoke(self.callback, **ctx.params)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/skynet/.local/share/uv/tools/cookiecutter/lib/python3.12/site-packages/click/core.py", line 783, in invoke
    return __callback(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/skynet/.local/share/uv/tools/cookiecutter/lib/python3.12/site-packages/cookiecutter/cli.py", line 203, in main
    cookiecutter(
  File "/Users/skynet/.local/share/uv/tools/cookiecutter/lib/python3.12/site-packages/cookiecutter/main.py", line 182, in cookiecutter
    result = generate_files(
             ^^^^^^^^^^^^^^^
  File "/Users/skynet/.local/share/uv/tools/cookiecutter/lib/python3.12/site-packages/cookiecutter/generate.py", line 409, in generate_files
    generate_file(
  File "/Users/skynet/.local/share/uv/tools/cookiecutter/lib/python3.12/site-packages/cookiecutter/generate.py", line 203, in generate_file
    tmpl = env.get_template(infile_fwd_slashes)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/skynet/.local/share/uv/tools/cookiecutter/lib/python3.12/site-packages/jinja2/environment.py", line 1013, in get_template
    return self._load_template(name, globals)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/skynet/.local/share/uv/tools/cookiecutter/lib/python3.12/site-packages/jinja2/environment.py", line 972, in _load_template
    template = self.loader.load(self, name, self.make_globals(globals))
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/skynet/.local/share/uv/tools/cookiecutter/lib/python3.12/site-packages/jinja2/loaders.py", line 138, in load
    code = environment.compile(source, name, filename)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/skynet/.local/share/uv/tools/cookiecutter/lib/python3.12/site-packages/jinja2/environment.py", line 768, in compile
    self.handle_exception(source=source_hint)
  File "/Users/skynet/.local/share/uv/tools/cookiecutter/lib/python3.12/site-packages/jinja2/environment.py", line 939, in handle_exception
    raise rewrite_traceback_stack(source=source)
  File "cliff.toml", line 54, in template
jinja2.exceptions.TemplateSyntaxError: expected token 'end of print statement', got ':'
  File "cliff.toml", line 54
    {{ self::print_commit(commit=commit) }}

Answered by pplmx

Aug 28, 2024

hi, @orhun

This is my final solution, which has the same effect as the cliff.toml file in the existing git-cliff repository. There’s no difference, and maybe you can use this updated version.

Thanks for your help. :)

body = """
{%- macro remote_url() -%}
  https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
{%- endmacro -%}

{% macro print_commit(commit) -%}
    - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
        {% if commit.breaking %}[**breaking**] {% endif %}\
        {{ commit.message | upper_first }} - \
        ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\
{% endmacro -%}

{% if version %}\
    …

View full answer

orhun · 2024-08-26T18:29:09Z

orhun
Aug 26, 2024
Maintainer

Hello 👋🏼 I'm not familiar with cookiecutter, but judging from this error:

  File "cliff.toml", line 54, in template
jinja2.exceptions.TemplateSyntaxError: expected token 'end of print statement', got ':'
  File "cliff.toml", line 54
    {{ self::print_commit(commit=commit) }}

It seems like it is related to your project's template generation, so it's not about git-cliff. I also tried out this config (after removing {% raw %} specifiers) and it worked fine for me.

Also, can you run git-cliff in a standalone way and let me know if it works?

0 replies

pplmx · 2024-08-27T00:56:37Z

pplmx
Aug 27, 2024
Author

Yep.
Running git-cliff in a standalone way is fine.

1 reply

orhun Aug 27, 2024
Maintainer

Then my guess is something in git-cliff's template clashes with the cookiecutter's template processor and it fails to build.

Maybe try removing/escaping whatever on line 54 and see if it builds that way. You might potentially need to add another {% raw %} specifier somewhere else or escape the template in some way.

The last resort would be reporting this to cookiecutter and let them take a look as well.

pplmx · 2024-08-28T12:54:17Z

pplmx
Aug 28, 2024
Author

hi, @orhun

This is my final solution, which has the same effect as the cliff.toml file in the existing git-cliff repository. There’s no difference, and maybe you can use this updated version.

Thanks for your help. :)

body = """
{%- macro remote_url() -%}
  https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
{%- endmacro -%}

{% macro print_commit(commit) -%}
    - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
        {% if commit.breaking %}[**breaking**] {% endif %}\
        {{ commit.message | upper_first }} - \
        ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\
{% endmacro -%}

{% if version %}\
    {% if previous.version %}\
        ## [{{ version | trim_start_matches(pat="v") }}]\
          ({{ self::remote_url() }}/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }}
    {% else %}\
        ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
    {% endif %}\
{% else %}\
    ## [unreleased]
{% endif %}\

{% for group, commits in commits | group_by(attribute="group") %}
    ### {{ group | striptags | trim | upper_first }}
    {% for commit in commits
    | filter(attribute="scope")
    | sort(attribute="scope") %}
        {{ self::print_commit(commit=commit) }}
    {%- endfor %}
    {% for commit in commits %}
        {%- if not commit.scope -%}
            {{ self::print_commit(commit=commit) }}
        {% endif -%}
    {% endfor -%}
{% endfor -%}
{%- if github -%}
{% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %}
  ## New Contributors ❤️
{% endif %}\
{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %}
  * @{{ contributor.username }} made their first contribution
    {%- if contributor.pr_number %} in \
      [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \
    {%- endif %}
{%- endfor -%}
{%- endif %}


"""

3 replies

orhun Aug 28, 2024
Maintainer

What exactly did you change there? Just removing the raw was enough?

pplmx Aug 28, 2024
Author

No,

First change: Remove the {% raw %} line and remove the dash (-).
Second change: Remove the {% raw %} line and add two blank lines.

See this picture

pplmx Aug 28, 2024
Author

Add a PR: #824

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

how to handle the jinja template in `cliff.toml` when using `cookiecutter` #818

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 3 comments 4 replies

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

Select a reply

how to handle the jinja template in cliff.toml when using cookiecutter #818

pplmx Aug 26, 2024

Question

Reproduce

Error

Replies: 3 comments · 4 replies

orhun Aug 26, 2024 Maintainer

pplmx Aug 27, 2024 Author

orhun Aug 27, 2024 Maintainer

pplmx Aug 28, 2024 Author

orhun Aug 28, 2024 Maintainer

pplmx Aug 28, 2024 Author

pplmx Aug 28, 2024 Author

how to handle the jinja template in `cliff.toml` when using `cookiecutter` #818

pplmx
Aug 26, 2024

Replies: 3 comments 4 replies

orhun
Aug 26, 2024
Maintainer

pplmx
Aug 27, 2024
Author

orhun Aug 27, 2024
Maintainer

pplmx
Aug 28, 2024
Author

orhun Aug 28, 2024
Maintainer

pplmx Aug 28, 2024
Author

pplmx Aug 28, 2024
Author