Closed brunobord closed 5 years ago
Originally, the changelog was meant to be restructured text. That is what zest.releaser was made for. Luck has it that markdown supports that header style :-)
... pressing enter too quickly...
ATX headers would mean quite some effort to support and quite some if/else, I am afraid. You could do some experimenting, of course. But I don’t want to increase the complexity of the code too much, to be honest.
That is what zest.releaser was made for. [..] ATX headers would mean quite some effort to support and quite some if/else, I am afraid.
It's either way:
But I don’t want to increase the complexity of the code too much, to be honest.
Fair enough I'll keep an eye on this issue :o)
TODO for us, also:
Right?
See #321
Documentation PR merged.
Context
zest.releaser
version:zest.releaser==6.17.0
, Python 3.6Let's consider the following "project", composed of two files. a
version.txt
:And a
Changelog.md
file, with the following content:As you can see, it's using the ATX-style headings. Then I'm running the
prerelease
command.Current result
The "version" file is correctly patched, but the "level-2" headings in the Changelog disappears and is not a section title anymore.
Expected result
I think that the headings should be preserved, like this: