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

Allow inserting the changelog inside a file using a marker #237

Open
jooola opened this issue Feb 28, 2023 · 0 comments
Open

Allow inserting the changelog inside a file using a marker #237

jooola opened this issue Feb 28, 2023 · 0 comments

Comments

@jooola
Copy link

jooola commented Feb 28, 2023

I propose to add a way to insert the generated change log in an existing file at a marker in this file.

For example I want to keep a header on the top of the change log file, and I don't want to regenerate the whole change log every time. I generate the change log for every release so I can fix outdated information and typos, and they should not be regenerated.

# Changelog title

This is part of the file header, it should stay at the top of the file.

<!-- git-chlog insert-marker -->

## 3.0.2 Some release entry (2023-02-21)

- My commit description

After running git-chlog, e.g git-chlog 3.0.2..3.1.0 --insert-into CHANGELOG.md

# Changelog title

This is part of the file header, it should stay at the top of the file.

<!-- git-chlog insert-marker -->

## 3.1.0 Some release entry (2023-03-21)

- My commit description

## 3.0.2 Some release entry (2023-02-21)

- My commit description

Expected Behavior

Insert the generated change log inside a file using a marker

Actual Behavior

This feature does not exists.

Your Environment

  • git-chglog version: git-chglog version 0.15.3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant