-
Notifications
You must be signed in to change notification settings - Fork 2k
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
Release process should have change log #1553
Comments
Is this what you're looking for? |
Wow, somehow I missed that. Would be nice to post that link in release tag on GitHub, also to have all such release notes in one place kept, so that it would be possible to see all release notes, since https://www.polymer-project.org/0.8/docs/release-notes.html link is not working. |
Hi @nazar-pc. I like the idea of posting the link in the release tag -- I'll ask our release maestro about that. This is the first release we've done formal release notes on the doc site, but going forward I'm planning on keeping the running release notes on the doc site. We don't have separate release notes for 0.5 => 0.8; because it was such a big, disruptive release, we created a migration guide. But that's guide's been updated to cover 0.5 => 0.9 to minimize the number of docs people had to read. That doc is here: https://www.polymer-project.org/0.9/docs/migration.html Hopefully the two docs cover most people's needs. After 0.9, we hope to return to a more normal release cycle -- with release notes! |
Super, thanks! |
Every time you tag new release there is no change log for it (which is true for WebComponents.js, even though it is separate now). Every time I scan all your blogs and nothing!
Now I was reading 0.8 docs, but it was just updated to 0.9. And how the hell should I know which sections changed and which are not so that I don't have to spend so much time reading everything once again?
My suggestion - create file
release-notes.md
, so that it will not rely on GitHub releases, put all anyhow significant changes there.Format might be like this.
Keeping such
release-notes.md
up to date (I do so for small projects) or updating right before each release (I do so for bigger projects) is crucial for successful migration to new versions.Yes, we are early adopters, we find bugs, dig into source code and even sending bug fixes back, just don't make it even more complex to use than it should be.
The text was updated successfully, but these errors were encountered: