Add CHANGELOG #40

flarnie · 2017-04-27T02:39:02Z

I'm really looking for any correction or insight here since I didn't make the changes listed, and the commit history is a bit convoluted.

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

**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

@bvaughn

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

bvaughn

It's unfortunate how clown-town these fixes look 🤡 but live and learn

bvaughn · 2017-04-27T03:01:31Z

CHANGELOG.md

+  and [this commit](https://github.com/reactjs/prop-types/commit/df318bba8a89bc5aadbb0292822cf4ed71d27ace).
+
+## 15.5.2
+* Fix bug where `prop-types` module was built with const instead of var `lib/ReactPropTypesSecret.js`. [See             #9370](https://github.com/facebook/react/issues/9370) and [this commit](https://github.com/facebook/react/commit/e1919638b39dd65eedd250a8bb649773ca61b6f1).


nit: Why the weird whitespace? [See•••••••••••••#9370]

bvaughn · 2017-04-27T03:01:55Z

CHANGELOG.md

@@ -0,0 +1,14 @@
+## 15.5.4
+* Fix UMD Build. [See this commit](https://github.com/reactjs/prop-types/commit/31e9344ca3233159928da66295da17dad82db1a8).
+* Remove dependencies on React in `package.json`. [See this commit](https://github.com/reactjs/prop-types/commit/158198fd6c468a3f6f742e0e355e622b3914048a).


This wasn't removing a dependency. Just fixing a bad package URL. (Wouldn't affect installs.)

gaearon · 2017-04-27T12:18:09Z

CHANGELOG.md

+  and [this commit](https://github.com/reactjs/prop-types/commit/df318bba8a89bc5aadbb0292822cf4ed71d27ace).
+
+## 15.5.2
+* Fix bug where `prop-types` module was built with const instead of var `lib/ReactPropTypesSecret.js`. [See             #9370](https://github.com/facebook/react/issues/9370) and [this commit](https://github.com/facebook/react/commit/e1919638b39dd65eedd250a8bb649773ca61b6f1).


I suggest that we do not get too technical in error messages. We never did before, and I think our format worked fairly well. So instead we could phrase this as:

Remove accidental uncompiled ES6 syntax in the published package.

gaearon · 2017-04-27T12:19:27Z

CHANGELOG.md

+* Remove dependencies on React in `package.json`. [See this commit](https://github.com/reactjs/prop-types/commit/158198fd6c468a3f6f742e0e355e622b3914048a).
+
+## 15.5.3
+* Inlined 'React.isValidElement' to eliminate dependency on React. [See #9371](https://github.com/facebook/react/issues/9371#issuecomment-292685424)


Nit: we should use backticks instead of single quotes here for formatting.
But I would probably just say "Remove the dependency on the react package"

gaearon

Let's make this a little less technical, fix formatting, and also use the same changelog format we are using in React repo (e.g. [@author] in [#PR/commit] rather than "see this commit" links).

flarnie · 2017-04-27T14:27:00Z

Thank you for reviewing! Will fix in a jiffy.

**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

gaearon · 2017-04-28T13:08:40Z

CHANGELOG.md

+## 15.5.3
+* Remove the dependency on the `react` package. ([@acdlite](https://github.com/acdlite) in [df318bb](https://github.com/reactjs/prop-types/commit/df318bba8a89bc5aadbb0292822cf4ed71d27ace))
+
+## 15.5.2


I think 15.5.2 added the UMD build (worth mentioning). But it was unnecessarily large by mistake.

https://unpkg.com/prop-types@15.5.2/prop-types.js
https://unpkg.com/prop-types@15.5.2/prop-types.min.js

Then 15.5.4 fixed its size (18 -> 4 kB pre gzip).

gaearon · 2017-04-28T13:09:20Z

CHANGELOG.md

@@ -0,0 +1,13 @@
+## 15.5.4
+* Fix UMD Build. ([@acdlite](https://github.com/acdlite) in [31e9344](https://github.com/reactjs/prop-types/commit/31e9344ca3233159928da66295da17dad82db1a8))


Maybe let's say "Reduce the size of the UMD build".

There is also an important change in 15.4.4:

Remove the accidentally included typechecking code from the production build.

gaearon · 2017-04-28T13:10:57Z

CHANGELOG.md

+* Remove bad package url. ([@ljharb](https://github.com/ljharb) in [158198f](https://github.com/reactjs/prop-types/commit/158198fd6c468a3f6f742e0e355e622b3914048a))
+
+## 15.5.3
+* Remove the dependency on the `react` package. ([@acdlite](https://github.com/acdlite) in [df318bb](https://github.com/reactjs/prop-types/commit/df318bba8a89bc5aadbb0292822cf4ed71d27ace))


This is probably "Remove the accidentally included React package code from the UMD bundle."

gaearon · 2017-04-28T13:11:54Z

CHANGELOG.md

+
+## 15.5.2
+* Remove accidental uncompiled ES6 syntax in the published package. ([@acdlite](https://github.com/acdlite) in [e191963](https://github.com/facebook/react/commit/e1919638b39dd65eedd250a8bb649773ca61b6f1))
+


I think 15.5.2 is the one that actually removed the (implicit) dependency on react:

https://unpkg.com/prop-types@15.5.2/index.js

Compare to 15.5.1:

https://unpkg.com/prop-types@15.5.1/index.js

gaearon · 2017-04-28T13:13:26Z

CHANGELOG.md

+* Remove the dependency on the `react` package. ([@acdlite](https://github.com/acdlite) in [df318bb](https://github.com/reactjs/prop-types/commit/df318bba8a89bc5aadbb0292822cf4ed71d27ace))
+
+## 15.5.2
+* Remove accidental uncompiled ES6 syntax in the published package. ([@acdlite](https://github.com/acdlite) in [e191963](https://github.com/facebook/react/commit/e1919638b39dd65eedd250a8bb649773ca61b6f1))


Accidental uncompiled syntax was removed in 15.5.1, not in 15.5.2:

https://unpkg.com/prop-types@15.5.0/lib/ReactPropTypesSecret.js
https://unpkg.com/prop-types@15.5.1/lib/ReactPropTypesSecret.js

gaearon · 2017-04-28T13:30:20Z

Please see comments above.
I wrote up changelog for further changes:

15.5.8

Limit the manual PropTypes call warning count because it has false positives with React versions earlier than 15.2.0 in the 15.x branch and 0.14.9 in the 0.14.x branch. (@gaearon in #26)

15.5.7

Critical Bugfix: Fix an accidental breaking change that caused errors in production when used through React.PropTypes. (@gaearon in #20)
Improve the size of production UMD build. (@aweary in 38ba18 and 7882a7)

15.5.6

Note: this release has a critical issue and was deprecated. Please update to 15.5.7 or higher.

Fix a markdown issue in README. (@bvaughn in 174f77

15.5.5

Note: this release has a critical issue and was deprecated. Please update to 15.5.7 or higher.

Add missing documentation and license files. (@bvaughn in 0a53d3

Please also add similar disclaimers about the deprecation to all earlier versions.

flarnie · 2017-04-28T15:28:40Z

Awesome - thanks @gaearon ! Updating this now.

**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

gaearon · 2017-04-28T16:08:03Z

CHANGELOG.md

+
+**Note: this release has a critical issue and was deprecated. Please update to 15.5.7 or higher.**
+
+* Remove the accidentally included React package code from the UMD bundle. ([@acdlite](https://github.com/acdlite) in [df318bb](https://github.com/reactjs/prop-types/commit/df318bba8a89bc5aadbb0292822cf4ed71d27ace))


This change (regarding UMD bundle) was done in 15.5.3, not in 15.5.2.

AFAIK 15.5.2 only fixed the CommonJS entry point not to depend on React.

Got it - fixing now.

**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

@bvaughn

* 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

gaearon · 2017-05-02T14:17:05Z

CHANGELOG.md

+
+**Note: this release has a critical issue and was deprecated. Please update to 15.5.7 or higher.**
+
+* Fix a markdown issue in README. ([@bvaughn](https://github.com/bvaughn) in [174f77](https://github.com/reactjs/prop-types/commit/174f77a50484fa628593e84b871fb40eed78b69a)


Missing closing paren

gaearon · 2017-05-02T14:17:17Z

CHANGELOG.md

+
+**Note: this release has a critical issue and was deprecated. Please update to 15.5.7 or higher.**
+
+* Add missing documentation and license files.  ([@bvaughn](https://github.com/bvaughn) in [0a53d3](https://github.com/reactjs/prop-types/commit/0a53d3a34283ae1e2d3aa396632b6dc2a2061e6a)


Missing closing paren

gaearon · 2017-05-02T14:17:50Z

CHANGELOG.md

+
+* Remove accidental uncompiled ES6 syntax in the published package. ([@acdlite](https://github.com/acdlite) in [e191963](https://github.com/facebook/react/commit/e1919638b39dd65eedd250a8bb649773ca61b6f1))
+
+## Before 15.5.1


Maybe worth adding 15.5.0 that just says "Initial release"

gaearon

Looks great (left a few last nits)

flarnie · 2017-05-02T20:35:26Z

Thanks! Fixing those now.

**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

flarnie requested review from bvaughn, gaearon and acdlite April 27, 2017 02:39

flarnie mentioned this pull request Apr 27, 2017

Update Changelog for v15.5.1-15.5.4 facebook/react#9537

Merged

bvaughn approved these changes Apr 27, 2017

View reviewed changes

gaearon reviewed Apr 27, 2017

View reviewed changes

gaearon suggested changes Apr 27, 2017

View reviewed changes

Improve CHANGELOG entries

f433938

**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

gaearon reviewed Apr 28, 2017

View reviewed changes

gaearon suggested changes Apr 28, 2017

View reviewed changes

flarnie added 2 commits April 28, 2017 09:04

gaearon reviewed Apr 28, 2017

View reviewed changes

Move annotations for v15.5.1-3 around in change log

019a3a9

**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

gaearon reviewed May 2, 2017

View reviewed changes

gaearon approved these changes May 2, 2017

View reviewed changes

Final nit fixes to CHANGELOG

4da3fa9

**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

flarnie merged commit bbaf238 into facebook:master May 3, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add CHANGELOG #40

Add CHANGELOG #40

flarnie commented Apr 27, 2017

bvaughn left a comment

bvaughn Apr 27, 2017

bvaughn Apr 27, 2017

gaearon Apr 27, 2017

gaearon Apr 27, 2017

gaearon left a comment

flarnie commented Apr 27, 2017

gaearon Apr 28, 2017 •

edited

gaearon Apr 28, 2017 •

edited

gaearon Apr 28, 2017

gaearon Apr 28, 2017

gaearon Apr 28, 2017

gaearon Apr 28, 2017

gaearon commented Apr 28, 2017 •

edited

flarnie commented Apr 28, 2017

gaearon Apr 28, 2017

flarnie May 1, 2017

gaearon May 2, 2017

gaearon May 2, 2017

gaearon May 2, 2017

gaearon left a comment

flarnie commented May 2, 2017

		@@ -0,0 +1,13 @@
		## 15.5.4
		* Fix UMD Build. ([@acdlite](https://github.com/acdlite) in [31e9344](https://github.com/reactjs/prop-types/commit/31e9344ca3233159928da66295da17dad82db1a8))


		## 15.5.2
		* Remove accidental uncompiled ES6 syntax in the published package. ([@acdlite](https://github.com/acdlite) in [e191963](https://github.com/facebook/react/commit/e1919638b39dd65eedd250a8bb649773ca61b6f1))


		Note: this release has a critical issue and was deprecated. Please update to 15.5.7 or higher.

		* Remove the accidentally included React package code from the UMD bundle. ([@acdlite](https://github.com/acdlite) in [df318bb](https://github.com/reactjs/prop-types/commit/df318bba8a89bc5aadbb0292822cf4ed71d27ace))


		Note: this release has a critical issue and was deprecated. Please update to 15.5.7 or higher.

		* Fix a markdown issue in README. ([@bvaughn](https://github.com/bvaughn) in [174f77](https://github.com/reactjs/prop-types/commit/174f77a50484fa628593e84b871fb40eed78b69a)


		Note: this release has a critical issue and was deprecated. Please update to 15.5.7 or higher.

		* Add missing documentation and license files. ([@bvaughn](https://github.com/bvaughn) in [0a53d3](https://github.com/reactjs/prop-types/commit/0a53d3a34283ae1e2d3aa396632b6dc2a2061e6a)


		* Remove accidental uncompiled ES6 syntax in the published package. ([@acdlite](https://github.com/acdlite) in [e191963](https://github.com/facebook/react/commit/e1919638b39dd65eedd250a8bb649773ca61b6f1))

		## Before 15.5.1

Add CHANGELOG #40

Add CHANGELOG #40

Conversation

flarnie commented Apr 27, 2017

bvaughn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gaearon left a comment

Choose a reason for hiding this comment

flarnie commented Apr 27, 2017

gaearon Apr 28, 2017 • edited

Choose a reason for hiding this comment

gaearon Apr 28, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gaearon commented Apr 28, 2017 • edited

15.5.8

15.5.7

15.5.6

15.5.5

flarnie commented Apr 28, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gaearon left a comment

Choose a reason for hiding this comment

flarnie commented May 2, 2017

gaearon Apr 28, 2017 •

edited

gaearon Apr 28, 2017 •

edited

gaearon commented Apr 28, 2017 •

edited