nedbat / scriv

Changelog management tool
https://scriv.readthedocs.io
Apache License 2.0
260 stars 29 forks source link

github-release command includes anchor of previous version #53

Closed rodrigogiraoserrao closed 2 years ago

rodrigogiraoserrao commented 2 years ago

When creating/updating releases with scriv github-release, the release description contains the anchor of the previous release.

I will gladly tackle this, provided you are not in a hurry to fix this; otherwise, go ahead.

nedbat commented 2 years ago

Can you show me what you mean? I haven't noticed this in my uses: https://github.com/nedbat/dinghy/releases

rodrigogiraoserrao commented 2 years ago

My CHANGELOG.md (note, it's a markdown changelog collected from markdown fragments) starts like this:

# Changelog

<!--scriv-insert-here-->

<a id='changelog-0.1.2'></a>
# 0.1.2 — 2022-06-30

## Added

- 100% code coverage.
- Code coverage reporting to tox.
- Tests to cover encoding and decoding that fails.

<a id='changelog-0.1.1'></a>
# 0.1.1 — 2022-06-25

## Added

- ...

Screenshot_3

My 0.1.2 release notes look like this;

## Added

- 100% code coverage.
- Code coverage reporting to tox.
- Tests to cover encoding and decoding that fails.

<a id='changelog-0.1.1'></a>

Screenshot_2

It looks like the changelog is just being truncated in the wrong place. My 0.1.1 release exhibits the same issue (it contains the anchor for the 0.1.0 heading). However, these anchors are not visible in the release, only when you try to edit the release notes.

nedbat commented 2 years ago

This is fixed in commit 31b8a4b.

nedbat commented 2 years ago

This is now released as part of scriv 0.16.0.