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

Update release notes #496

Open
wants to merge 3 commits into
base: master
from

Conversation

Projects
None yet
2 participants
@JakeGinnivan

JakeGinnivan commented Jun 25, 2014

I saw the latest release of Chocolatey and your release notes are very close to what I generate with a tool I am working on called GitReleaseNotes. So I decided to use this as a demo and hopefully help you out at the same time.

@JakeGinnivan

This comment has been minimized.

Show comment
Hide comment
@JakeGinnivan

JakeGinnivan Jun 25, 2014

I have written a blog post about this, hopefully it saves you some time in the future. http://jake.ginnivan.net/blog/2014/06/26/updating-chocolateys-release-notes-with-gitreleasenotes/

Would love feedback at any rate.

-Jake

JakeGinnivan commented Jun 25, 2014

I have written a blog post about this, hopefully it saves you some time in the future. http://jake.ginnivan.net/blog/2014/06/26/updating-chocolateys-release-notes-with-gitreleasenotes/

Would love feedback at any rate.

-Jake

@ferventcoder

This comment has been minimized.

Show comment
Hide comment
@ferventcoder

ferventcoder Jun 26, 2014

It's a little jarring to have h1 versus h2. The format I followed is what I'm seeing out there, particularly with vagrant changelogs and other sources. I can't find anywhere on the SRN where it says it must be h1. Can you point me to the specific example that shows a true set of release notes? The examples don't even elaborate but rather make it seem that my sections should be H1, which is to say BREAKING CHANGES, IMPROVEMENTS, BUG FIXES, etc.

ferventcoder commented on f541d8c Jun 26, 2014

It's a little jarring to have h1 versus h2. The format I followed is what I'm seeing out there, particularly with vagrant changelogs and other sources. I can't find anywhere on the SRN where it says it must be h1. Can you point me to the specific example that shows a true set of release notes? The examples don't even elaborate but rather make it seem that my sections should be H1, which is to say BREAKING CHANGES, IMPROVEMENTS, BUG FIXES, etc.

This comment has been minimized.

Show comment
Hide comment
@JakeGinnivan

JakeGinnivan Jun 26, 2014

Owner

Good point, maybe I need to update GitReleaseNotes to allow either. Will look into that

Owner

JakeGinnivan replied Jun 26, 2014

Good point, maybe I need to update GitReleaseNotes to allow either. Will look into that

@ferventcoder

This comment has been minimized.

Show comment
Hide comment
@ferventcoder

ferventcoder Jun 26, 2014

Commits is interesting..

ferventcoder commented on 2b3e67b Jun 26, 2014

Commits is interesting..

This comment has been minimized.

Show comment
Hide comment
@ferventcoder

ferventcoder Jun 26, 2014

I'm guessing this is what can never be changed as the new builds off of this.

ferventcoder replied Jun 26, 2014

I'm guessing this is what can never be changed as the new builds off of this.

This comment has been minimized.

Show comment
Hide comment
@JakeGinnivan

JakeGinnivan Jun 26, 2014

Owner

This allow me to get accurate timing of when the release notes were last generated. It is also handy to link as a unified diff of the changes in that release if people are interested.

This could probably be done using the release name, and vNext or Unreleased could have the commit in it so it can append during a release. Happy for ideas

Owner

JakeGinnivan replied Jun 26, 2014

This allow me to get accurate timing of when the release notes were last generated. It is also handy to link as a unified diff of the changes in that release if people are interested.

This could probably be done using the release name, and vNext or Unreleased could have the commit in it so it can append during a release. Happy for ideas

# vNext
- [#493](https://github.com/chocolatey/chocolatey/issues/493) - [Enhancement] Chocolatey-Update cleanup
- [#492](https://github.com/chocolatey/chocolatey/issues/492) - Error messages late in update of chocolatey itself

This comment has been minimized.

@ferventcoder

ferventcoder Jul 2, 2014

Member

This issue https://github.com/chocolatey/chocolatey/issues/492 was closed without being fixed. How should it be set up for GRN to handle that?

@ferventcoder

ferventcoder Jul 2, 2014

Member

This issue https://github.com/chocolatey/chocolatey/issues/492 was closed without being fixed. How should it be set up for GRN to handle that?

This comment has been minimized.

@JakeGinnivan

JakeGinnivan Jul 3, 2014

Just delete the line. The idea is that it is more work collecting/putting them together than editing/removing stuff which should not be there

@JakeGinnivan

JakeGinnivan Jul 3, 2014

Just delete the line. The idea is that it is more work collecting/putting them together than editing/removing stuff which should not be there

This comment has been minimized.

@ferventcoder

ferventcoder Jul 3, 2014

Member

I see. I was hoping we could have some special tag/label that would cause these items not to get included.

@ferventcoder

ferventcoder Jul 3, 2014

Member

I see. I was hoping we could have some special tag/label that would cause these items not to get included.

This comment has been minimized.

@JakeGinnivan

JakeGinnivan Jul 3, 2014

Certainly could be added, tags to exclude or something

@JakeGinnivan

JakeGinnivan Jul 3, 2014

Certainly could be added, tags to exclude or something

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment