Tag 15.5.{1,2,3,4}, update docs #9443
Comments
|
15.5.x was a really rocky release and IIRC anything other than 15.5.4 is flawed or broken in some way. 😞 Do we ever "skip" bad versions in the changelogs? I don't want to give people the impression that updating to, e.g. 15.5.3, is safe. How would you handle this? Additionally different addons had different breakages in different patch versions, and they’re not lined up even now. Not sure if it matters or not, but we used to sync them up to the main version but can’t anymore. |
|
I would still ensure the git tags are there. I would probably add them to the changelog and just include that those version are broken. I'd even go a step further and make sure that we As for the out-of-sync-ness… yea, that's why I avoided getting out of sync as much as possible for so long. It'll happen more as we move to out-of-sync monorepos though so no time like the present to figure it out 😉. What I started doing for fbjs is make the tags |
|
I want to add them and note them as "Yanked". See http://keepachangelog.com/en/0.3.0/: |
|
I think it is OK if broken releases are not tagged on github. But if 15.5.4 is the working one, we should have a 15.5.4 release on github too. Otherwise, people using the download will get 15.5.0 |
|
I'll have a draft of the changelogs up soon! @stof You are right that we could probably skip broken versions. I am imagining that for anyone who, for whatever reason, ended up downloading the broken versions, it could be useful to see more info about that version and where it falls in the timeline. So while it would be ok for us to skip annotating those versions, I'd like to add notes about them just in case someone finds it helpful. |
**what is the change?:** Adding a `CHANGELOG.md` **why make this change?:** Since this package is out of sync from React, and is more of a stand-alone module now, we should put records of the changes in it's own change log. **test plan:** visual inspection **issue:** facebook/react#9443
This could really use extra code review attention since the history of these changes was a bit convoluted to follow. After talking to @bvaughn and @acdlite, we thought it might make sense to put the 'add-ons' changes in a separate change log. The other option, of including them in the main React change log, seemed the more confusing of the two. Also this commit is related to and somewhat blocked by facebook/prop-types#40 **what is the change?:** Adding the change log for recent patch versions of React. **why make this change?:** We missed this step in the flurry of releasing patches, and it's useful for folks who want info about what version to use. **test plan:** Visual inspection of the change log. **issue:** facebook#9443
**what is the change?:** - reformat using '[@author] in [#PR/commit]' - Make annotations less technical and more correct **why make this change?:** To improve readability and consistency. **test plan:** Visual inspection **issue:** facebook/react#9443
**what is the change?:** - Add deprecation warning to all versions pre 15.5.7. - Move 'React package inclusion fix' annotation from 15.5.3 to 15.5.2 - Improved wording of 'Reduce size of UMD build' in 15.5.4 - Add note about 'Remove the accidentally included typechecking code...' in 15.5.4 (what commit did this?) - Move 'Remove accidental uncompiled ES6' annotation to 15.5.1 - That leaves no changes under 15.5.3; maybe we released this in an effort to keep this in sync with the main React package? Follow up commit adds annotations for 15.5.4-15.5.8. **why make this change?:** To be more accurate. **test plan:** Visual inspection. **issue:** facebook/react#9443
**what is the change?:** See title. **why make this change?:** To provide information about the version history, and to get people updated to the latest version of this package. **test plan:** Visual inspection. **issue:** facebook/react#9443
**what is the change?:** - Put backticks around package names - Reformat link to to commit in '([@user](...) in [#NNNN](...))' format - Remove newlines after subheaders; in the past we sometimes have included a newline after the subheader, but most recently it looks like we do not. - Add some missing punctuation. **why make this change?:** Consistency and aesthetics **test plan:** Visual inspection **issue:** facebook#9443
**what is the change?:** Another correction to the change log, based on helpful comments from @gaeaeron. **why make this change?:** Accuracy **test plan:** Visual inspection **issue:** facebook/react#9443
* Update Changelog for v15.5.1-15.5.4 This could really use extra code review attention since the history of these changes was a bit convoluted to follow. After talking to @bvaughn and @acdlite, we thought it might make sense to put the 'add-ons' changes in a separate change log. The other option, of including them in the main React change log, seemed the more confusing of the two. Also this commit is related to and somewhat blocked by facebook/prop-types#40 **what is the change?:** Adding the change log for recent patch versions of React. **why make this change?:** We missed this step in the flurry of releasing patches, and it's useful for folks who want info about what version to use. **test plan:** Visual inspection of the change log. **issue:** #9443 * Further improve CHANGELOG entries for v15.5.1-15.5.4 **what is the change?:** - Use the '[@author] in [#PR/commit]' format for annotations - Make annotations less technical, more clear - Move 'React Addons' updates into main changelog - Remove separate 'React Addons' changelog **why make this change?:** These changes each make things more clear and accurate. **test plan:** Visual inspection **issue:** * Fix final nits in CHANGELOG **what is the change?:** - Put backticks around package names - Reformat link to to commit in '([@user](...) in [#NNNN](...))' format - Remove newlines after subheaders; in the past we sometimes have included a newline after the subheader, but most recently it looks like we do not. - Add some missing punctuation. **why make this change?:** Consistency and aesthetics **test plan:** Visual inspection **issue:** #9443 * Add deprecation notice to v15.5.0-15.5.3 **what is the change?:** Adding deprecation notice to some recent React versions. **why make this change?:** These versions of React use a version of `prop-types` that had a critical bug. We updated the dependency in React 15.5.4, and hopefully people will see this notice and update. **test plan:** Visual inspection **issue:** #9537
|
Changelog and git tags are updated - please reopen and comment if I missed anything. |
**what is the change?:** Adding two missing parens and a note about the initial release version. **why make this change?:** Clarity/consistency **test plan:** Visual inspection **issue:** facebook/react#9443
|
Thanks! The website still said 15.5.0 is the latest, probably want to update https://github.com/facebook/react/blob/15-stable/docs/_config.yml#L63 so the site will rebuild. |
|
Bumped the website version. |
* Add CHANGELOG **what is the change?:** Adding a `CHANGELOG.md` **why make this change?:** Since this package is out of sync from React, and is more of a stand-alone module now, we should put records of the changes in it's own change log. **test plan:** visual inspection **issue:** facebook/react#9443 * Improve `CHANGELOG` entries **what is the change?:** - reformat using '[@author] in [#PR/commit]' - Make annotations less technical and more correct **why make this change?:** To improve readability and consistency. **test plan:** Visual inspection **issue:** facebook/react#9443 * Further corrections to CHANGELOG **what is the change?:** - Add deprecation warning to all versions pre 15.5.7. - Move 'React package inclusion fix' annotation from 15.5.3 to 15.5.2 - Improved wording of 'Reduce size of UMD build' in 15.5.4 - Add note about 'Remove the accidentally included typechecking code...' in 15.5.4 (what commit did this?) - Move 'Remove accidental uncompiled ES6' annotation to 15.5.1 - That leaves no changes under 15.5.3; maybe we released this in an effort to keep this in sync with the main React package? Follow up commit adds annotations for 15.5.4-15.5.8. **why make this change?:** To be more accurate. **test plan:** Visual inspection. **issue:** facebook/react#9443 * Add change log for v15.5.4-15.5.8 - credit to @gaearon **what is the change?:** See title. **why make this change?:** To provide information about the version history, and to get people updated to the latest version of this package. **test plan:** Visual inspection. **issue:** facebook/react#9443 * Move annotations for v15.5.1-3 around in change log **what is the change?:** Another correction to the change log, based on helpful comments from @gaeaeron. **why make this change?:** Accuracy **test plan:** Visual inspection **issue:** facebook/react#9443 * Final nit fixes to CHANGELOG **what is the change?:** Adding two missing parens and a note about the initial release version. **why make this change?:** Clarity/consistency **test plan:** Visual inspection **issue:** facebook/react#9443
Looks like the git tags were missed in the followup 15.5.x releases and the website still says 15.5.0 is the latest.
(I'd do it myself but just in case there are other things that happen these days, I'll let you all handle it)
The text was updated successfully, but these errors were encountered: