grunt-saucelabs icon indicating copy to clipboard operation
grunt-saucelabs copied to clipboard

Published 20 hours ago • verified publisher icon axemclion

Use Release Tab to document release history

Open geekdave opened this issue 11 years ago • 7 comments

Would be a big help to see a high-level summary of changes from version-to-version, especially when it comes to potentially breaking changes, or new APIs available.

Thanks!

Edit Changed from recommending README section to releases tab, per @nschonni 's suggestion below.

geekdave avatar Oct 08 '13 18:10 geekdave

:+1:, but I think the Release tab would be a better place https://github.com/blog/1547-release-your-software

nschonni avatar Oct 08 '13 18:10 nschonni

@nschonni ah, didn't know about that. Editing my original issue. :)

geekdave avatar Oct 08 '13 18:10 geekdave

@geekdave That makes perfect sense. I think I am to blame for not maintaining the release history. Now that a lot of people are using this library, I think a more rigorous release process makes sense.

axemclion avatar Oct 08 '13 20:10 axemclion

@axemclion could you go back and actually push the git tags for the releases? That would be a good start :+1:

nschonni avatar Nov 12 '13 18:11 nschonni

Bump v7 was just released but there is still now change log between versions

nschonni avatar May 23 '14 18:05 nschonni

v8.0.1 is out and I used tags and the releases page.

Do you think it that important to go back and retroactively create tags?

Is it okay if I keep changelog data in the README? I want a record independent of git/github

Jonahss avatar May 30 '14 21:05 Jonahss

:+1: thanks @Jonahss I've done the retroactive tag creating in the past and sometimes it can confuse the github release page.

Is it okay if I keep changelog data in the README? I want a record independent of git/github

Sure, but maybe consider moving it to a Changlog.md instead so it can be generated instead.

nschonni avatar May 31 '14 16:05 nschonni