ember-cli-github-pages

0.2.2 verified Sat Apr 25 auth: no javascript maintenance

Ember CLI addon for deploying Ember apps to GitHub Pages. v0.2.2 is the latest release (last updated ~2019) and is in maintenance mode. It provides ember-cli commands to build and commit to gh-pages branch, with support for project, user, and organization pages, including options like --branch and rootURL. No active development, but stable for existing Ember projects.

Common errors

error Could not find command 'github-pages:commit'. ↓

cause Addon not installed or not loaded by ember-cli.

fix

Run ember install ember-cli-github-pages and ensure it's in devDependencies.

error Path or pattern .gitignore did not match any files ↓

cause gh-pages branch created incorrectly, missing .gitignore.

fix

Recreate gh-pages branch following the setup steps exactly.

Warnings

gotcha The addon modifies tests/dummy/config/environment.js automatically; ensure Git is clean before installing. ↓

fix Check for uncommitted changes before running `ember install ember-cli-github-pages`.

gotcha For Org/User pages, rootURL is typically '/'; the addon's default rootURL configuration may cause broken assets. ↓

fix Manually set rootURL to '/' in config/environment.js before deployment.

gotcha The addon expects a 'master' branch for Org/User pages; using --branch master is required or gh-pages must track origin/master. ↓

fix Either pass --branch master or set up branch tracking with `git branch --set-upstream gh-pages origin/master`.

deprecated Node engine requirement: 8.* || >= 10.*; Node 8 is EOL. ↓

fix Use Node >=10.x for compatibility.

Install

npm install ember-cli-github-pages

yarn add ember-cli-github-pages

pnpm add ember-cli-github-pages

Quickstart

Install the addon and run the commit command to deploy to gh-pages.

ember install ember-cli-github-pages --save-dev
ember github-pages:commit --message "Deploy to GitHub Pages"