Skip to content

Describe deployment for the blueprint the gem now supports - #670

Merged
tricknotes merged 1 commit into
mainfrom
heroku-docs-vite-blueprint
Sep 7, 2026
Merged

Describe deployment for the blueprint the gem now supports#670
tricknotes merged 1 commit into
mainfrom
heroku-docs-vite-blueprint

Conversation

@tricknotes

@tricknotes tricknotes commented Sep 7, 2026

Copy link
Copy Markdown
Owner

Documentation-only. Brings the Heroku and Capistrano instructions in line with the build system the gem now centers on.

Why

The deployment instructions were written when every EmberCLI application was a classic Broccoli build that installed Bower dependencies. An application generated with ember-cli >= 6.8 has no bower.json, so a reader following the README today is told to configure a Bower executable that nothing runs and to link a bower_components directory that is never created.

They were also left to guess whether Vite's development server — the visible difference between the two build systems — changes anything about a deploy. It does not: App#build only starts the development server in development (lib/ember_cli/app.rb), so production is identical for both blueprints.

Nothing said which NodeJS the build runs on, either. Heroku's NodeJS buildpack reads engines.node from the project root's package.json — the file rails generate ember:heroku writes — and builds on the current LTS release when that file names no version, while the Vite-based blueprint requires NodeJS >= 20.19.0.

What changed

  • Heroku — dropped the Bower buildpack step; stated that a Vite-based application deploys exactly like a classic one; added a NodeJS-version note pointing at the file the buildpack actually reads.
  • Capistrano — described what the gem installs today (npm install, or yarn install for a yarn-configured application); refreshed the nvm $PATH example off NodeJS v4.2.1; dropped bower_components from the linked_dirs example.
  • Corrected asset:precompile to assets:precompile, the task lib/tasks/ember-cli.rake actually hooks.

Notes

  • Runtime Bower support is deliberately untouched. The gem still supports classic EmberCLI >= 1.13.13, so Shell#install and the generated package.json's bower dependency stay exactly as they are.
  • No new Bower prose is added — the Bower-specific steps are simply removed from instructions that presented them as unconditional.
  • The NodeJS note asks the reader to check the generated package.json. heroku-generator-node-engines makes the generator write engines.node itself; if that lands, this paragraph stays true and simply becomes a description of what the generator already did.

Verification

No code changed, so nothing to run. Reviewed the rendered sections for correct anchors (#vite-based-applications) and link definitions.

🤖 Generated with Claude Code

https://claude.ai/code/session_014rAfkAVGVifbaEoTVeT66u

The Heroku and Capistrano instructions were written when every EmberCLI
application was a classic Broccoli build that installed Bower dependencies.
An application generated with `ember-cli >= 6.8` has no `bower.json`,
so its readers were told to configure a Bower executable that nothing runs
and to link a `bower_components` directory that is never created.
They were also left to guess whether Vite's development server —
the visible difference between the two build systems —
changes anything about a deploy. It does not:
the development server only runs in `development`.

Nothing said which NodeJS the build runs on either,
though the buildpack takes it from the `package.json` the generator writes
and falls back to the current LTS release when that file names no version,
while the Vite-based blueprint requires NodeJS `>= 20.19.0`.

Drop the steps that only ever applied to a Bower build,
say what installs the dependencies today,
and state the NodeJS requirement where each deployment target reads it.
Also correct `asset:precompile` to the `assets:precompile` task the gem
actually hooks.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014rAfkAVGVifbaEoTVeT66u
@tricknotes
tricknotes force-pushed the heroku-docs-vite-blueprint branch from 3f07474 to 742aeed Compare September 7, 2026 12:08
@tricknotes
tricknotes marked this pull request as ready for review September 7, 2026 12:12
@tricknotes
tricknotes merged commit 8f2a277 into main Sep 7, 2026
12 checks passed
@tricknotes
tricknotes deleted the heroku-docs-vite-blueprint branch September 7, 2026 12:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants