mattbrictson / chandler

[unmaintained] chandler syncs your CHANGELOG entries to GitHub's release notes
MIT License
152 stars 15 forks source link

on release notes update are version dates overwritten to current date #39

Open typekpb opened 7 years ago

typekpb commented 7 years ago

I've applied chandler on the project and noticed that all the dates are now overwritten with the date of update.

Is there a chance to fix it?

Current text says:

[username] released this 2 days ago · [XY] commits to master since this release

The problem is, that I introduced it to the project couple ears old (also with releases couple years old), but it seems these were released only couple days back.

I'd appreciate a chance to take the release date from the relese notes (as we have it there anyway).

mattbrictson commented 7 years ago

Thanks for the report. Unfortunately I don't think there is a way to edit the date of a GitHub release. The API docs do not mention dates at all in the create and update commands:

https://developer.github.com/v3/repos/releases/#create-a-release

I am open to suggestions but I can't figure out a way to do it.

typekpb commented 7 years ago

Well in the api seems to be also edit a release functionality. Hope it would not touch the release date. How about that?

On Aug 23, 2017 17:47, "Matt Brictson" notifications@github.com wrote:

Thanks for the report. Unfortunately I don't think there is a way to edit the date of a GitHub release. The API docs do not mention dates at all in the create and update commands:

https://developer.github.com/v3/repos/releases/#create-a-release

I am open to suggestions but I can't figure out a way to do it.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/mattbrictson/chandler/issues/39#issuecomment-324378073, or mute the thread https://github.com/notifications/unsubscribe-auth/AAegbFYivfRv8y5tZKSrumFL4jJyXg2Yks5sbEl8gaJpZM4PABDU .

typekpb commented 7 years ago

It could update existing ones, not touched by chandler yet.

On Aug 23, 2017 18:07, butkovic@gmail.com wrote:

Well in the api seems to be also edit a release functionality. Hope it would not touch the release date. How about that?

On Aug 23, 2017 17:47, "Matt Brictson" notifications@github.com wrote:

Thanks for the report. Unfortunately I don't think there is a way to edit the date of a GitHub release. The API docs do not mention dates at all in the create and update commands:

https://developer.github.com/v3/repos/releases/#create-a-release

I am open to suggestions but I can't figure out a way to do it.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/mattbrictson/chandler/issues/39#issuecomment-324378073, or mute the thread https://github.com/notifications/unsubscribe-auth/AAegbFYivfRv8y5tZKSrumFL4jJyXg2Yks5sbEl8gaJpZM4PABDU .

mattbrictson commented 7 years ago

Chandler already tries to update an existing release if it is present:

https://github.com/mattbrictson/chandler/blob/756c9842b14135d251ed53bb310ebc5b8ff19177/lib/chandler/github.rb#L20-L29

Do you have any guesses as to why is not working for your particular case?

mattbrictson commented 7 years ago

As an experiment, I re-ran this command on the Chandler repository after making some edits to the CHANGELOG:

$ chandler push v0.7.0
Push v0.7.0… ✔ 0.423s

The release notes at GitHub were updated, but the date did not change. It still says Dec 23, 2016.

https://github.com/mattbrictson/chandler/releases/tag/v0.7.0

So perhaps the problem only exists for new releases. I.e. you had a tag that existed for a long time but never created an actual release for it. Then when Chandler runs it creates a release for that tag, and the release is marked with today's date.

Does that sound like a plausible explanation of what you're running into?

typekpb commented 7 years ago

Makes sense

On Aug 23, 2017 21:38, "Matt Brictson" notifications@github.com wrote:

As an experiment, I re-ran this command on the Chandler repository after making some edits to the CHANGELOG:

$ chandler push v0.7.0 Push v0.7.0… ✔ 0.423s

The release notes at GitHub were updated, but the date did not change. It still says Dec 23, 2016.

https://github.com/mattbrictson/chandler/releases/tag/v0.7.0

So perhaps the problem only exists for new releases. I.e. you had a tag that existed for a long time but never created an actual release for it. Then when Chandler runs it creates a release for that tag, and the release is marked with today's date.

Does that sound like a plausible explanation of what you're running into?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/mattbrictson/chandler/issues/39#issuecomment-324440665, or mute the thread https://github.com/notifications/unsubscribe-auth/AAegbHbi10o4YyCziqGLf9Xi-GiH70S8ks5sbH-_gaJpZM4PABDU .

mattbrictson commented 5 years ago

⚠️ This project is no longer actively maintained. I have found myself embracing tools like release-drafter to keep release notes updated automatically, rather than relying on a manually edited CHANGELOG.md. If you are interested in taking over chandler development, let me know by opening an issue.