Enhancing .changelog-config.yaml with Full Rendering Support

[changemyminds]

This is an amazing project! I’ve been using it in my monorepo, and I have a question.

I noticed that .changelog-config.yaml allows the use of variables under the variables section, where I can define some parameters. However, I found that it currently only supports args and kwargs. configuration.html

Would it be possible to extend support to fully render the entire .changelog-config.yaml file? This would provide more flexibility, such as applying variables to tag_pattern, ignore_patterns, and other configurations.

Looking forward to your thoughts on this!

[coordt]

This is an exciting idea.

Why would you want them as variables instead of setting the value directly? I don't believe multiple uses exist for the value of tag_pattern. However, I would love to hear some interesting new ideas about it.

[changemyminds]

Hi @coordt, sorry for the late response.

Here is an monorepo example. I created the project_a and project_b for testing.

# create project
mkdir -p monorepo-test
cd monorepo-test
git init

# create project_a and commit message
poetry new project_a 
git add .
git commit -m "feat(project_a): init project_a"

# create project_b and commit message
poetry new project_b
git add .
git commit -m "feat(project_b): init project_b"

# check git log
$ git log --oneline | cat
cbed7ae feat(project_b): init project_b
cc37f1b feat(project_a): init project_a

# git tag
$ cd ..
$ git tag -a project_a/v0.1.0 -m "release(project_a): bump version v0.1.0"
$ git tag -a project_b/v0.1.0 -m "release(project_b): bump version v0.1.0"

# check git tag
$ git tag | cat                                                           
project_a/v0.1.0
project_b/v0.1.0

# add generate-changelog library and init it in the project_a
cd project_a
poetry add generate-changelog --group dev
source $(poetry env info --path)/bin/activate
generate-changelog --generate-config

# add git commit message
git add .
git commit -m "feat(project_a): add generate-changelog"

# check git log
$ git log --oneline | cat
5fe2439 feat(project_a): add generate-changelog
cbed7ae feat(project_b): init project_b
cc37f1b feat(project_a): init project_a

Note: Our git commit header rule is <type>(<project_directory>): <subject>

I want to use the generate-changelog command to generate the CHANGELOG.md file in my project_a directory. However, you will see the message contains the project_b, which is not what we expect. We only want to focus on project_a for Git commit information.

# generate the CHANGELOG.md
$ generate-changelog --output release-hint
patch

# check the CHANGELOG.md file
$ cat CHANGELOG.md
# Changelog

## Unreleased (2025-02-25)

### Other

- Feat(project_a): add generate-changelog.
    
- Feat(project_b): init project_b.
    
- Feat(project_a): init project_a.

Therefore, we modify the .changelog-config.yaml file and use the generate-changelog command to generate it again.

variables:
  changelog_filename: CHANGELOG.md
  # HINT: setup the project_name as project_a
  project_name: project_a

starting_tag_pipeline:
  - action: ReadFile
    kwargs:
      filename: '{{ changelog_filename }}'
  - action: FirstRegExMatch
    kwargs:
      # HINT: match the first CHANGLOG.md file version 
      pattern: (?im)^## {{ project_a }}/v(?P<rev>\d+\.\d+(?:\.\d+)?)\s+\(\d+-\d{2}-\d{2}\)$
      named_subgroup: rev

# HINT: match the tag(project_a/v0.1.0)
tag_pattern: ^project_a/v[0-9]+\.[0-9]+\.[0-9]+$

ignore_patterns:
  # same ...
  # HINT: This pattern will ignore non-project[-_]a commits.
  - '^(?!.*project[-_]a).*$'

commit_classifiers:
  - action: SummaryRegexMatch
    category: New
    kwargs:
      # HINT: add feat
      pattern: (?i)^(?:new|add|feat)[^\n]*$

  # same ...

Check the result.

$ cat CHANGELOG.md
# Changelog

## Unreleased (2025-02-25)

### New

- Feat(project_a): add generate-changelog.
    
## project_a/v0.1.0 (2025-02-25)

### New

- Feat(project_a): init project_a.

As you can see, each project needs a .changelog-config.yaml file. We must modify the following parameters in each .changelog-config.yaml file across our projects. I want to use the {{ project_a }} parameter in the tag_pattern and create a new parameter named project_name_regx and set it value to '^(?!.*project[-_]a).*$'. This will allow me to use the same .changelog-config.yaml file in each project and only modify the variables parameters.

• pattern: (?im)^## {{ project_a }}/v(?P<rev>\d+\.\d+(?:\.\d+)?)\s+\(\d+-\d{2}-\d{2}\)$
• tag_pattern: ^project_a/v[0-9]+\.[0-9]+\.[0-9]+$
• '^(?!.*project[-_]a).*$'

Do you have any good ideal or best practice to reduce the issue?