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.

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

Strange looking output when mixing changelog flags in one section #10

Closed
crywolf opened this issue Oct 24, 2023 · 2 comments
Closed

Strange looking output when mixing changelog flags in one section #10

crywolf opened this issue Oct 24, 2023 · 2 comments
Labels
question Further information is requested

Comments

@crywolf
Copy link
Owner

crywolf commented Oct 24, 2023

When we mix title-is-enough: true with inherit: all the produced output looks strange. I believe it's working according to the original example, but I think we should change it somehow. Any idea? @Kixunil

Example:

Don't ignore read errors

When reading yaml config, mkchlog would silently ignore read erros which
could lead to confusion or even broken data (if the error happened
exactly at line boundary). This change passes the error to the caller
instead.

changelog:
        section: bug_fixes
        inherit: all
Skip merge commits

Merge commits does not follow required format and would be rejected as invalid. So they are just filtered out by calling `git log` command with `--no-merges` option.

changelog:
    section: bug_fixes
    title-is-enough: true
Do not display sections without content

Section containing empty subsection were previously displayed. Enhanced tests in Template.

changelog:
    section: bug_fixes
    title-is-enough: true

Output:

## Fixed bugs

### Don't ignore read errors

When reading yaml config, mkchlog would silently ignore read erros which could lead to confusion or even broken data (if the error happened exactly at line boundary). This change passes the error to the caller instead.

* Skip merge commits

* Do not display sections without content
@crywolf crywolf added the question Further information is requested label Oct 24, 2023
@Kixunil
Copy link
Contributor

Kixunil commented Oct 24, 2023

Fully agree. Perhaps put changes without description at the beginning so it becomes:

## Fixed bugs

* Skip merge commits

* Do not display sections without content

### Don't ignore read errors

When reading yaml config, mkchlog would silently ignore read erros which could lead to confusion or even broken data (if the error happened exactly at line boundary). This change passes the error to the caller instead.

Or put them into ### Other changes section:

## Fixed bugs

### Don't ignore read errors

When reading yaml config, mkchlog would silently ignore read erros which could lead to confusion or even broken data (if the error happened exactly at line boundary). This change passes the error to the caller instead.

### Other changes

* Skip merge commits

* Do not display sections without content

The first one seems slightly better to me.

@crywolf
Copy link
Owner Author

crywolf commented Nov 3, 2023

Implemented by 34e4807, so I am closing it.

@crywolf crywolf closed this as completed Nov 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants