Skip to content

Commit 19c322e

Browse files
justin808claude
andcommitted
Improve package metadata and Pro upgrade CTAs (#3112)
Improve RubyGems and npm package discovery so React on Rails users land on the docs site and get a clearer, low-noise path to evaluate Pro. This updates the OSS gem post-install message, points gem and npm homepage/documentation metadata at `reactonrails.com`, and adds concise README upgrade/trial links for the OSS and Pro npm packages. It also adds package `repository.directory` metadata so npm package pages resolve to the right folder in the monorepo. ~~- [ ] Add/update test to cover these changes~~ - [x] Update documentation ~~- [ ] Update CHANGELOG file~~ Validation included local RubyGems/npm install-message experiments, `package.json` parsing, gemspec loading, and Prettier; RuboCop on the gemspecs still reports the repo's existing `Gemspec/DevelopmentDependencies` offenses. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Low risk: changes are limited to package/gem metadata, README links, and a post-install message, with no runtime logic impact aside from updated gem dependencies ordering/metadata fields. > > **Overview** > Updates npm packages (`react-on-rails`, `react-on-rails-pro`, and `react-on-rails-pro-node-renderer`) to improve discoverability by adding `repository.directory` metadata and pointing `homepage` links to `reactonrails.com` docs. > > Refreshes documentation/CTAs: adds an OSS README section promoting Pro with evaluation/licensing links, updates the Pro README to use the docs site and include upgrade/trial messaging, and enhances both gemspecs with richer RubyGems metadata plus an updated `react_on_rails` post-install message directing users to Pro resources. (Also reorders/adds Pro gem runtime dependency entries without changing versions.) > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit be7227c. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> * **Documentation** * Updated documentation links across packages to point to the new documentation portal. * Added licensing clarification: React on Rails Pro is free for evaluation in development, CI/CD, and staging environments; paid licensing required only for production deployments. * Enhanced README with information about React on Rails Pro features and OSS vs. Pro comparison. * **Chores** * Updated package and gem metadata to include directory references and point to the new documentation domain. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent edfc878 commit 19c322e

7 files changed

Lines changed: 48 additions & 19 deletions

File tree

packages/react-on-rails-pro-node-renderer/package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,8 @@
9191
},
9292
"repository": {
9393
"type": "git",
94-
"url": "git+https://github.com/shakacode/react_on_rails.git"
94+
"url": "git+https://github.com/shakacode/react_on_rails.git",
95+
"directory": "packages/react-on-rails-pro-node-renderer"
9596
},
9697
"keywords": [
9798
"react",
@@ -106,7 +107,7 @@
106107
"bugs": {
107108
"url": "https://github.com/shakacode/react_on_rails/issues"
108109
},
109-
"homepage": "https://github.com/shakacode/react_on_rails/tree/main/packages/react-on-rails-pro-node-renderer#readme",
110+
"homepage": "https://reactonrails.com/docs/pro/node-renderer/",
110111
"jest": {
111112
"clearMocks": true,
112113
"moduleNameMapper": {

packages/react-on-rails-pro/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# react-on-rails-pro
22

3-
The client-side JavaScript package for [React on Rails Pro](https://github.com/shakacode/react_on_rails). This package **replaces** the base `react-on-rails` package and re-exports everything from it, plus Pro-exclusive features like React Server Components support.
3+
The client-side JavaScript package for [React on Rails Pro](https://reactonrails.com/docs/pro/). This package **replaces** the base `react-on-rails` package and re-exports everything from it, plus Pro-exclusive features like React Server Components support.
44

55
## Installation
66

@@ -14,6 +14,8 @@ pnpm add react-on-rails-pro
1414

1515
**Important:** When using the `react_on_rails_pro` Ruby gem, you **must** use this package (`react-on-rails-pro`) instead of `react-on-rails`. If the Pro gem detects the base `react-on-rails` npm package at runtime, it will raise an error.
1616

17+
React on Rails Pro is free to evaluate in development, CI/CD, and staging. A paid license is required only for production deployments.
18+
1719
## Usage
1820

1921
### Component Registration
@@ -90,7 +92,8 @@ See the [full installation guide](https://reactonrails.com/docs/pro/installation
9092
- [Installation Guide](https://reactonrails.com/docs/pro/installation)
9193
- [Configuration Reference](https://reactonrails.com/docs/configuration/configuration-pro)
9294
- [React Server Components Tutorial](https://reactonrails.com/docs/pro/react-server-components/tutorial)
93-
- [React on Rails Pro Overview](https://pro.reactonrails.com/)
95+
- [Upgrade from OSS to Pro](https://reactonrails.com/docs/pro/upgrading-to-pro/)
96+
- [React on Rails Pro Overview](https://reactonrails.com/docs/pro/)
9497

9598
## License
9699

packages/react-on-rails-pro/package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@
1717
},
1818
"repository": {
1919
"type": "git",
20-
"url": "git+https://github.com/shakacode/react_on_rails.git"
20+
"url": "git+https://github.com/shakacode/react_on_rails.git",
21+
"directory": "packages/react-on-rails-pro"
2122
},
2223
"keywords": [
2324
"react",
@@ -82,7 +83,7 @@
8283
"bugs": {
8384
"url": "https://github.com/shakacode/react_on_rails/issues"
8485
},
85-
"homepage": "https://github.com/shakacode/react_on_rails#readme",
86+
"homepage": "https://reactonrails.com/docs/pro/",
8687
"devDependencies": {
8788
"@types/mock-fs": "^4.13.4",
8889
"mock-fs": "^5.5.0",

packages/react-on-rails/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@ pnpm add react-on-rails
1414

1515
**Using React on Rails Pro?** Install [`react-on-rails-pro`](https://www.npmjs.com/package/react-on-rails-pro) instead. The Pro package re-exports everything from this package plus Pro-exclusive features. The `react_on_rails_pro` gem requires the Pro npm package.
1616

17+
## Need More Than OSS?
18+
19+
If you want React Server Components, streaming SSR, fragment caching, or faster Node-based SSR, try [`react-on-rails-pro`](https://www.npmjs.com/package/react-on-rails-pro). It is free to evaluate in development, CI/CD, and staging; production licenses are required only for production deployments.
20+
21+
- [Compare OSS vs Pro](https://reactonrails.com/docs/getting-started/oss-vs-pro/)
22+
- [Pro quick start](https://reactonrails.com/docs/getting-started/pro-quick-start/)
23+
- [React on Rails Pro overview](https://reactonrails.com/docs/pro/)
24+
1725
## Quick Start
1826

1927
### Register Components

packages/react-on-rails/package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
},
1616
"repository": {
1717
"type": "git",
18-
"url": "git+https://github.com/shakacode/react_on_rails.git"
18+
"url": "git+https://github.com/shakacode/react_on_rails.git",
19+
"directory": "packages/react-on-rails"
1920
},
2021
"keywords": [
2122
"react",
@@ -69,5 +70,5 @@
6970
"bugs": {
7071
"url": "https://github.com/shakacode/react_on_rails/issues"
7172
},
72-
"homepage": "https://github.com/shakacode/react_on_rails#readme"
73+
"homepage": "https://reactonrails.com/docs/"
7374
}

react_on_rails/react_on_rails.gemspec

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,16 @@ Gem::Specification.new do |s|
1313

1414
s.summary = "Rails with react server rendering with webpack. "
1515
s.description = "See README.md"
16-
s.homepage = "https://github.com/shakacode/react_on_rails"
16+
s.homepage = "https://reactonrails.com/docs/"
1717
s.license = "MIT"
18+
s.metadata = {
19+
"bug_tracker_uri" => "https://github.com/shakacode/react_on_rails/issues",
20+
"changelog_uri" => "https://github.com/shakacode/react_on_rails/blob/main/CHANGELOG.md",
21+
"documentation_uri" => "https://reactonrails.com/docs/",
22+
"homepage_uri" => "https://reactonrails.com/docs/",
23+
"rubygems_mfa_required" => "true",
24+
"source_code_uri" => "https://github.com/shakacode/react_on_rails/tree/main/react_on_rails"
25+
}
1826

1927
s.files = Dir.chdir(__dir__) do
2028
`git ls-files -z`.split("\x0").reject do |f|
@@ -37,12 +45,14 @@ Gem::Specification.new do |s|
3745
s.add_dependency "shakapacker", ">= 6.0"
3846

3947
s.add_development_dependency "gem-release"
40-
s.post_install_message = '
41-
--------------------------------------------------------------------------------
42-
Checkout https://pro.reactonrails.com for information about
43-
"React on Rails Pro" which includes a gem for better performance, via caching helpers, and our
44-
node rendering server, support for React 19, and much more.
45-
--------------------------------------------------------------------------------
46-
'
48+
s.post_install_message = <<~MESSAGE
49+
--------------------------------------------------------------------------------
50+
Need React Server Components, streaming SSR, caching, or faster Node-based SSR?
51+
React on Rails Pro is free to try in development, CI/CD, and staging.
52+
Compare OSS vs Pro: https://reactonrails.com/docs/getting-started/oss-vs-pro/
53+
Pro quick start: https://reactonrails.com/docs/getting-started/pro-quick-start/
54+
Contact ShakaCode: https://www.shakacode.com/contact/
55+
--------------------------------------------------------------------------------
56+
MESSAGE
4757
end
4858
# rubocop:enable Metrics/BlockLength

react_on_rails_pro/react_on_rails_pro.gemspec

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,14 @@ Gem::Specification.new do |s|
1616

1717
s.summary = "Rails with react server rendering with webpack. Performance helpers"
1818
s.description = "See README.md"
19-
s.homepage = "https://github.com/shakacode/react_on_rails_pro"
19+
s.homepage = "https://reactonrails.com/docs/pro/"
2020
s.license = "UNLICENSED"
2121
s.metadata["rubygems_mfa_required"] = "true"
22+
s.metadata["bug_tracker_uri"] = "https://github.com/shakacode/react_on_rails/issues"
23+
s.metadata["changelog_uri"] = "https://github.com/shakacode/react_on_rails/blob/main/CHANGELOG.md"
24+
s.metadata["documentation_uri"] = "https://reactonrails.com/docs/pro/"
25+
s.metadata["homepage_uri"] = "https://reactonrails.com/docs/pro/"
26+
s.metadata["source_code_uri"] = "https://github.com/shakacode/react_on_rails/tree/main/react_on_rails_pro"
2227

2328
s.files = Dir.chdir(__dir__) do
2429
`git ls-files -z`.split("\x0").reject do |f|
@@ -32,14 +37,14 @@ Gem::Specification.new do |s|
3237
s.required_ruby_version = ">= 3.0"
3338

3439
s.add_runtime_dependency "addressable"
40+
s.add_runtime_dependency "async", ">= 2.29"
3541
s.add_runtime_dependency "connection_pool"
3642
s.add_runtime_dependency "execjs", "~> 2.9"
37-
s.add_runtime_dependency "httpx", ">= 1.7.0"
3843
# Needed to avoid this bug at httpx versions >= 1.6.0:
3944
# https://github.com/HoneyryderChuck/httpx/issues/118
4045
s.add_runtime_dependency "http-2", ">= 1.1.1"
46+
s.add_runtime_dependency "httpx", "~> 1.5"
4147
s.add_runtime_dependency "jwt", "~> 2.7"
42-
s.add_runtime_dependency "async", ">= 2.29"
4348
s.add_runtime_dependency "rainbow"
4449
s.add_runtime_dependency "react_on_rails", ReactOnRails::VERSION
4550
s.add_development_dependency "bundler"

0 commit comments

Comments
 (0)