namolnad/finch

A configurable command line tool to easily create and format version changelogs

finch's Issues

[feature-request] - Allow for Multiple Changelog Items Per Commit

Is your feature request related to a problem? Please describe.

Allow for two change log messages within one commit.

As it stands now if there is a single newline between items in a commit, the tags for each commit are parsed, but the messaging is placed under the first tag's title.

Eg.

Commit Message:

[Fixed] Fixed a really bad bug
[Added] Added a new feature

The output will be (using the default format string):

### Fixed
 - |fixed| |added| Fixed a really bad bug [Added] Added a new feature

If you do this with two newlines between commit messages only the first line is parsed.

Eg.

Commit Message:

[Fixed] Fixed a really bad bug

[Added] Added a new feature

The output will be (using the default format string):

### Fixed
 - |fixed| Fixed a really bad bug

Note the [Added] commit message is missing.

Describe the solution you'd like

Ideally both of the cases above would output as follows:

### Fixed
 - |fixed| Fixed a really bad bug 

### Added
 - |added| Added a new feature

Describe alternatives you've considered

Additional context

Filter out empty sections

If a section is empty (doesn't have any commits in a given changeset), should filter it out

Using project-dir doesn’t reference that dir for configuration

Need to set project-dir in configurator

[bug] Compare throwing not git repository error

Describe the bug
Keep getting fatal: not a git repository: when trying to do a compare. I am testing this currently in a sample project. It could be that I do it have it setup properly.

To Reproduce
Steps to reproduce the behavior:

1. Install finch using the brew method
2. Create the .finch folder and config using the template
3. Run the compare between two versions

Expected behavior
A changelog should be generated

Screenshots

Desktop (please complete the following information):

• OS: macOS
• Version 13.4

Additional context
Add any other context about the problem here.

Config:

format:
format_string: ' - << message >> - << commit_type_hyperlink >>'
section_infos:

• capitalizes_message: true
  tags:
  • feature
    title: Features
• capitalizes_message: true
  tags:
  • bug
    title: Bug Fixes
• capitalizes_message: true
  tags:
  • cleanup
• capitalizes_message: true
  tags:
  • refactor

git:
repo_base_url: {{REPO_URL}}
resolution_commands:
build_number: /usr/bin/env bash -c 'git -C $PROJECT_DIR rev-list $NEW_VERSION --count'

[bug] Non-empty default values for child config components override parent configs

Describe the bug
Default values for section infos (possibly other areas) override parent configs even if there are specific values set there. This was noticed with a private config files overriding the section infos from the regular config file even though section_infos was not a present key in the private config. This may be happening for other non-empty default values within configs.

To Reproduce
Steps to reproduce the behavior:

1. Create a private config with only users as it's contents
2. Have a regular config file which has your custom section_infos
3. See the section_infos are not your custom values, but the defaults when you run finch compare

Expected behavior
A clear and concise description of what you expected to happen.

Desktop (please complete the following information):

• OS: macOS
• Version 0.0.21