I would call it a bug, one which perhaps occurs for users that do not use the Rake task way of configuration - since there they have the full power of Ruby - they can add "\n" as they want to in their configuration line.

Are you using the configuration file way of configuring, here? (Asking to narrow down where to try finding the current behavior.)

Proposed Workaround 1: use a Rakefile and configure the task with Rake.

Update:

         opts.on("--front-matter JSON", "Add YAML front matter. Formatted as JSON because it's easier to add on the command line.") do |v|
          options[:frontmatter] = "#{JSON.parse(v).to_yaml}---\n"
        end

By formatting your test as a JSON string, you can add newlines.

But, this makes me thing of YAML front-matter: it's not just a text section, it has a specific meaning. It is meant to be a section for YAML configuration of the Markdown document. Metadata, information that can't be inside the document.

https://jekyllrb.com/docs/front-matter/

I am using the docker image and the configuration file .github_changelog_generator.

@jorgecarleitao

An example input in the field would be something like

github_changelog_generator --front-matter '{"hello":"world"}'

which would turn into a YAML preamble aka front-matter.

If you try adding that single option as a CLI configuration option, does that generate a YAML frontmatter?

Thanks a lot @olleolleolle for your fast reply and help.

So, that seems to raise an error instead:

/usr/local/bundle/gems/github_changelog_generator-1.16.2/lib/github_changelog_generator/argv_parser.rb:76:in `block (2 levels) in parser': undefined method `to_yaml' for {"hello"=>"world"}:Hash (NoMethodError)
Did you mean?  to_a

command:

docker run -it --rm -e CHANGELOG_GITHUB_TOKEN=$CHANGELOG_GITHUB_TOKEN \
    -v "$(pwd)":/usr/local/src/your-app \
    githubchangeloggenerator/github-changelog-generator \
    --user apache \
    --project arrow-rs \
    --since-commit 2021-04-20 \
    --future-release 4.0.1 \
    --front-matter '{"hello":"world"}'

@jorgecarleitao That's good news, since we can change the to_yaml to a YAML.generate implementation instead.

Update: The problem was just that the YAML library was not yet loaded.

The bug fix has been released as v1.16.3.

wow, thank you so much for such a quick reaction, fix and release ❤️

Much appreciated, @olleolleolle !

Does this release triggered the release of a new docker image?

@jorgecarleitao I don't think that it does. I don't know exactly how that works, though!