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

How to use custom announcement message? #1690

Open
nik-rev opened this issue Jan 10, 2025 · 3 comments
Open

How to use custom announcement message? #1690

nik-rev opened this issue Jan 10, 2025 · 3 comments

Comments

@nik-rev
Copy link

nik-rev commented Jan 10, 2025

In my repo I have CHANGELOG.md. I manually edit this file with changes between versions.
When I publish a new version like v1.2.7, I would like it to automatically look at the diff in CHANGELOG.md between the new version v1.2.7 and the previous version v1.2.6, then use that diff to create the same body in the announcement

How can I accomplish this? Cheers!

@mistydemeo
Copy link
Contributor

We try to do this automatically. For example, if you take a look at this release body: https://github.com/axodotdev/cargo-dist/releases/tag/v0.28.0

You can see that it's the same content that's in the version 0.28.0 section of our changelog: https://github.com/axodotdev/cargo-dist/blob/main/CHANGELOG.md#version-0280-2025-01-08

Is this not working for you? If so, what does the formatting on your changelog look like? It's possible we're having trouble figuring out where the content is in yours.

@nik-rev
Copy link
Author

nik-rev commented Jan 10, 2025

We try to do this automatically. For example, if you take a look at this release body: https://github.com/axodotdev/cargo-dist/releases/tag/v0.28.0

You can see that it's the same content that's in the version 0.28.0 section of our changelog: https://github.com/axodotdev/cargo-dist/blob/main/CHANGELOG.md#version-0280-2025-01-08

Is this not working for you? If so, what does the formatting on your changelog look like? It's possible we're having trouble figuring out where the content is in yours.

Thanks for the quick reply, and nice to know that it's a feature! I don't get this because i don't think my changelog matches with the format

this is my changelog: https://github.com/nik-rev/patchy/blob/main/CHANGELOG.md

is there e.g. a regex used to determine whether it gets included or not? or what format really do i need to use?

@mistydemeo
Copy link
Contributor

We use the parse-changelog crate. So, for the time being, I suppose the answer is we support whatever parse-changelog supports.

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

2 participants