Skip to content

Commit

Permalink
refactor(@angular/cli): removed the github pages deploy command (#4385)
Browse files Browse the repository at this point in the history
BREAKING CHANGE: This command is being removed from the core of the CLI
There are several options for deploying CLI-based applications outside the scope of this project.
One of which being https://github.com/angular-buch/angular-cli-ghpages
This functionality is likely to return in the form of an addon/plugin in the future
  • Loading branch information
Brocco authored and hansl committed Feb 3, 2017
1 parent d2f8ca7 commit 0f8689b
Show file tree
Hide file tree
Showing 9 changed files with 1 addition and 808 deletions.
32 changes: 0 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ with NPM 3 or higher.
* [Running Unit Tests](#running-unit-tests)
* [Running End-to-End Tests](#running-end-to-end-tests)
* [Proxy To Backend](#proxy-to-backend)
* [Deploying the App via GitHub Pages](#deploying-the-app-via-github-pages)
* [Linting code](#linting-code)
* [Commands autocompletion](#commands-autocompletion)
* [Project assets](#project-assets)
Expand Down Expand Up @@ -237,37 +236,6 @@ and then we edit the `package.json` file's start script to be

now run it with `npm start`

### Deploying the app via GitHub Pages

You can deploy your apps quickly via:

```bash
ng github-pages:deploy --message "Optional commit message"
```

This will do the following:

- creates GitHub repo for the current project if one doesn't exist
- rebuilds the app in production mode at the current `HEAD`
- creates a local `gh-pages` branch if one doesn't exist
- moves your app to the `gh-pages` branch and creates a commit
- edit the base tag in index.html to support GitHub Pages
- pushes the `gh-pages` branch to GitHub
- returns back to the original `HEAD`

Creating the repo requires a token from GitHub, and the remaining functionality
relies on ssh authentication for all git operations that communicate with github.com.
To simplify the authentication, be sure to [setup your ssh keys](https://help.github.com/articles/generating-ssh-keys/).

If you are deploying a [user or organization page](https://help.github.com/articles/user-organization-and-project-pages/), you can instead use the following command:

```bash
ng github-pages:deploy --user-page --message "Optional commit message"
```

This command pushes the app to the `master` branch on the GitHub repo instead
of pushing to `gh-pages`, since user and organization pages require this.


### Linting code

Expand Down
30 changes: 0 additions & 30 deletions docs/documentation/stories/deploy-github-pages.md

This file was deleted.

1 change: 0 additions & 1 deletion packages/@angular/cli/addon/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ module.exports = {
'version': require('../commands/version').default,
'completion': require('../commands/completion').default,
'doc': require('../commands/doc').default,
'github-pages-deploy': require('../commands/github-pages-deploy').default,

// Easter eggs.
'make-this-awesome': require('../commands/easter-egg').default,
Expand Down
4 changes: 0 additions & 4 deletions packages/@angular/cli/blueprints/ng2/files/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,6 @@ Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
Before running the tests make sure you are serving the app via `ng serve`.

## Deploying to GitHub Pages

Run `ng github-pages:deploy` to deploy to GitHub Pages.

## Further help

To get more help on the `angular-cli` use `ng help` or go check out the [Angular-CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
272 changes: 0 additions & 272 deletions packages/@angular/cli/commands/github-pages-deploy.run.ts

This file was deleted.

Loading

0 comments on commit 0f8689b

Please sign in to comment.