From 00c41949a6a1d1444c0a7abdf1c02a1203d0629f Mon Sep 17 00:00:00 2001 From: Justin Gordon Date: Thu, 7 Sep 2017 08:33:44 -1000 Subject: [PATCH] Updated Docs --- CHANGELOG.md | 72 ++++------------------------------------------------ README.md | 8 +++--- 2 files changed, 9 insertions(+), 71 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1ed7c3b03..b2d76ca9a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,11 +8,11 @@ Changes since last non-beta release. *Please add entries here for your pull requests.* -- Fix regression where `react_component(... prerender: true)` wouldn't find the generated asset bundle, because it wasn't looking for the hashed path. +### [9.0.0] +Updated React on Rails to depend on [rails/webpacker](https://github.com/rails/webpacker). [PR 908](https://github.com/shakacode/react_on_rails/pull/908) by [justin808](https://github.com/justin808). -## 9.0 from 8.x. Upgrade Instructions -All 9.0.0 beta versions can be viewed in [PR 908](https://github.com/shakacode/react_on_rails/pull/908) +#### 9.0 from 8.x. Upgrade Instructions For an example of upgrading, see [react-webpack-rails-tutorial/pull/416](https://github.com/shakacode/react-webpack-rails-tutorial/pull/416). @@ -96,56 +96,6 @@ gem "webpacker" - Set the `hmr` key in your `webpacker.yml` to `true`. -#### Troubleshooting - - - -### [9.0.0] -*Diffs for the beta to master* - -### [9.0.0-beta.12] -- Updated for latest rails/webpacker using the official gem -- hot reloading working in generator - -### [9.0.0-beta.11] -- Updated for latest rails_webpacker. -- hot reloading working in spec/dummy - -### [9.0.0-beta.10] -- Updated for the latest rails/webpacker. Added the cache_manifest setting. - -### [9.0.0-beta.9] -- Fixes precompile task going to Webpacker's. You need to set `custom_compile: true` in your `webpacker.yml`. -- Changed webpack-bundle.js name to hello-world-bundle.js -- Update for latest from rails/webpacker -gem "webpacker", git: "https://github.com/shakacode/webpacker.git", - branch: "issue-464-merge-webpacker-lite-into-webpacker-v3" - -### [9.0.0-beta.8] -- bugfix for server rendering - -### [9.0.0-beta.7] -- Depend on updated rails/webpacker in branch - -gem "webpacker", git: "https://github.com/shakacode/webpacker.git", - branch: "issue-464-merge-webpacker-lite-into-webpacker-v2" - - -### [9.0.0-beta.6] -- Change "hot" to "hmr". - -### [9.0.0-beta.3] -- Fix typo on webpackConfigLoader.js - -### [9.0.0-beta.3] -- Fix typo on webpackConfigLoader.js - -### [9.0.0-beta.2] -- Fixed problems when running in development mode for both the generator and spec/dummy. - -### [9.0.0-beta.1] -- First version of depending on Webpacker rather than Webpacker Lite - ### [8.0.7] #### fixed - Fixes generator bug by keeping blank line at top in case existing .gitignore does not end in a newline. [#916](https://github.com/shakacode/react_on_rails/pull/916) by [justin808](https://github.com/justin808). @@ -768,20 +718,8 @@ Best done with Object destructing: ##### Fixed - Fix several generator related issues. -[Unreleased]: https://github.com/shakacode/react_on_rails/compare/rails-webpacker...9.0.0-beta.11 -[9.0.0]: https://github.com/shakacode/react_on_rails/compare/master...9.0.0-beta.11 -[9.0.0-beta.12]: https://github.com/shakacode/react_on_rails/compare/9.0.0-beta.11...9.0.0-beta.12 -[9.0.0-beta.11]: https://github.com/shakacode/react_on_rails/compare/9.0.0-beta.10...9.0.0-beta.11 -[9.0.0-beta.10]: https://github.com/shakacode/react_on_rails/compare/9.0.0-beta.9...9.0.0-beta.10 -[9.0.0-beta.9]: https://github.com/shakacode/react_on_rails/compare/9.0.0-beta.8...9.0.0-beta.9 -[9.0.0-beta.8]: https://github.com/shakacode/react_on_rails/compare/9.0.0-beta.7...9.0.0-beta.8 -[9.0.0-beta.7]: https://github.com/shakacode/react_on_rails/compare/9.0.0-beta.6...9.0.0-beta.7 -[9.0.0-beta.6]: https://github.com/shakacode/react_on_rails/compare/9.0.0-beta.5...9.0.0-beta.6 -[9.0.0-beta.5]: https://github.com/shakacode/react_on_rails/compare/9.0.0-beta.4...9.0.0-beta.5 -[9.0.0-beta.4]: https://github.com/shakacode/react_on_rails/compare/9.0.0-beta.3...9.0.0-beta.4 -[9.0.0-beta.3]: https://github.com/shakacode/react_on_rails/compare/9.0.0-beta.2...9.0.0-beta.3 -[9.0.0-beta.2]: https://github.com/shakacode/react_on_rails/compare/9.0.0-beta.1...9.0.0-beta.2 -[9.0.0-beta.1]: https://github.com/shakacode/react_on_rails/compare/master...9.0.0-beta.1 +[Unreleased]: https://github.com/shakacode/react_on_rails/compare/9.0.0...master +[9.0.0]: https://github.com/shakacode/react_on_rails/compare/8.0.7...9.0.0 [8.0.7]: https://github.com/shakacode/react_on_rails/compare/8.0.6...8.0.7 [8.0.6]: https://github.com/shakacode/react_on_rails/compare/8.0.5...8.0.6 [8.0.5]: https://github.com/shakacode/react_on_rails/compare/8.0.3...8.0.5 diff --git a/README.md b/README.md index b1c3f9563..c69de3901 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,8 @@ # React on Rails v9 is based on Webpacker 3.0! -* See the updated [Tutorial](https://github.com/shakacode/react_on_rails/blob/rails-webpacker/docs/tutorial.md). -* See the [CHANGELOG.md](https://github.com/shakacode/react_on_rails/blob/rails-webpacker/CHANGELOG.md) for migration instructions. +* See the updated [Tutorial](https://github.com/shakacode/react_on_rails/blob/master/docs/tutorial.md). +* See the [CHANGELOG.md](https://github.com/shakacode/react_on_rails/blob/master/CHANGELOG.md) for migration instructions. ## Steps to a New App with rails/webpacker v3 plus React on Rails v9.beta: 1. New Rails app: `rails new my-app --webpack=react`. `cd` into the directory. @@ -95,9 +95,9 @@ For more testimonials, see [Live Projects](PROJECTS.md) and [Kudos](./KUDOS.md). ------ # NEWS -* **[VERSION 9.0.0.beta (branch)](https://github.com/shakacode/react_on_rails/tree/rails-webpacker) shipped!** This version depends on Webpacker directly. See the [CHANGELOG.md](https://github.com/shakacode/react_on_rails/blob/rails-webpacker/CHANGELOG.md) for migration instructions. +* 2017-09-06: **VERSION 9.0.0 shipped!** This version depends on Webpacker directly. See the [CHANGELOG.md](https://github.com/shakacode/react_on_rails/blob/master/CHANGELOG.md) for migration instructions. * [VERSION 8.1.0](https://rubygems.org/gems/react_on_rails/) shipped with [webpacker_lite](https://github.com/shakacode/webpacker_lite) (soon [**webpacker**](https://github.com/rails/webpacker/issues/464#issuecomment-310986140) support! [react-webpack-rails-tutorial PR #395](https://github.com/shakacode/react-webpack-rails-tutorial/pull/395) shows the changes needed to migrate from the Asset Pipeline to Webpacker Lite. For more information, see my article: [Webpacker Lite: Why Fork Webpacker?](https://blog.shakacode.com/webpacker-lite-why-fork-webpacker-f0a7707fac92). Per recent discussions, we [will merge Webpacker Lite changes back into Webpacker](https://github.com/rails/webpacker/issues/464#issuecomment-310986140). There's no reason to wait for this. The upgrade will eventually be trivial. -* The Docs here on `master` refer to 8.1.0 including support for [webpacker_lite](https://github.com/shakacode/webpacker_lite). The docs on [on the 9.0.0 beta branch](https://github.com/shakacode/react_on_rails/tree/rails-webpacker) refer to using Webpacker rather than Webpacker Lite. +* The Docs here on `master` refer to 9.x including support for [rails/webpacker](https://github.com/rails/webpacker). *Use the [7.0.4 docs](https://github.com/shakacode/react_on_rails/tree/7.0.4) to refer to the older asset pipeline way.* * *See [NEWS.md](NEWS.md) for more notes over time.*