work in progress...

Author: JohannesHoppe

.circleci/config.yml

@@ -28,7 +28,7 @@ jobs:
 
       - run: cd angular-testdrive && npm run build
       - run: chmod +x bin/angular-cli-ghpages
-      - run: cd angular-testdrive && ../bin/angular-cli-ghpages --repo "$GITHUB_ORG/$NAME.git" --name "$GITHUB_NAME" --email "$GITHUB_EMAIL" --dir=dist/angular-testdrive --cname=angular-cli-ghpages.angular.schule
+      - run: cd angular-testdrive && ../angular-cli-ghpages --repo "$GITHUB_ORG/$NAME.git" --name "$GITHUB_NAME" --email "$GITHUB_EMAIL" --dir=dist/angular-testdrive --cname=angular-cli-ghpages.angular.schule
 
     branches:
       only:

.editorconfig

@@ -0,0 +1,13 @@
+# Editor configuration, see http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

.vscode/launch.json

@@ -9,7 +9,7 @@
             "request": "launch",
             "name": "Launch Program",
             "cwd": "${workspaceRoot}/angular-testdrive",
-            "program": "${workspaceFolder}/bin/angular-cli-ghpages",
+            "program": "${workspaceFolder}/angular-cli-ghpages",
             "args": [
                 "--dir=dist/angular-testdrive",
                 "--cname=angular-cli-ghpages.angular.schule"

README.md

@@ -2,222 +2,68 @@
 [![NPM version][npm-image]][npm-url]
 [![CircleCI](https://circleci.com/gh/angular-schule/angular-cli-ghpages.svg?style=svg)](https://circleci.com/gh/angular-schule/angular-cli-ghpages)
 
+<!--
+TODO: cool screenshot with animated gif
 <hr>
-
-![Screenshot](screenshot-travis.png)
+ ![Screenshot](screenshotgif)
+ -->
 
 <hr>
 
 Deploy your Angular app to GitHub pages directly from the Angular CLI! 🚀
-Brought to you by the [angular.schule](https://angular.schule/) team! 
-
-## Changelog
-
-A detailed changelog is available in the [releases](https://github.com/angular-schule/angular-cli-ghpages/releases) section.
-
-<!--
-## Installation & Setup
-
-This command has the following prerequisites:
-
-- `Node.js 8.2.0` or higher which brings you `npm 5.2.0` which brings you [`npx`](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) 
-- Git 1.7.6 or higher
-- __optional__: Angular project created via [angular-cli](https://github.com/angular/angular-cli)
-
-To install the command run the following:
-
-```bash
-npm i angular-cli-ghpages --save-dev
-```
-
-Note: you can skip the permanent installation, too. The command `npx` is also able to install `angular-cli-ghpages` on the first usage, if you want. 
-
-## Usage
-
-Execute `npx angular-cli-ghpages` in order to deploy the project with a build from `dist` folder.  
-__Note: you have to create the  `dist` folder in before (e.g. `ng build --prod`)__
-
-Usage:
-
-```bash
-ng build --prod --base-href "https://USERNAME.github.io/REPOSITORY_NAME/"
-npx angular-cli-ghpages [OPTIONS]
-```
-
-or
-
-```bash
-ng build --prod --base-href "/REPOSITORY_NAME/"
-npx angular-cli-ghpages [OPTIONS]
-```
-
-or (`<base href="/">` stays untouched)
-
-```bash
-ng build --prod
-npx angular-cli-ghpages [OPTIONS]
-```
-
-If you want to push to `gh-pages` on the same repository with your default credentials, then just enter `npx angular-cli-ghpages` without any options.
-
-
-### Usage with Angular CLI 6 or higher
-
-With Angular CLI 6 the build artifacts will be put in a subfolder under `dist`.
-Please take a look at the `dist` folder to see whether there is a subfolder with your project's name or not.
-If yes, you need to specify the deploy directory manually then when using this tool:
-
-```bash
-npx angular-cli-ghpages --dir=dist/[PROJECTNAME]
-```
-
-I most cases, the `[PROJECTNAME]` can be found in the `angular.json` file at `defaultProject`.
-
-
-### Usage with Ionic
-
-You can use the tool with Angular based Ionic projects, too. Instead of the ` dist` folder, the Ionic CLI will create a `www` folder you have to point the tool to. Just use the following commands:
 
-```bash
-ionic build --prod -- --base-href=https://USERNAME.github.io/REPOSITORY_NAME/`
-```
 
-```bash
-npx angular-cli-ghpages --dir=www
-```
+## 📖 Changelog <a name="changelog"></a>
 
+A detailed changelog is available in the [releases](https://github.com/angular-schule/angular-cli-ghpages/releases) section.
 
+In the past this project was a standalone program.
+This is still possible.
+See the documentation at (https://github.com/angular-schule/angular-cli-ghpages/blob/master/README_standalone.md)[README_standalone].
 
-## Extra
-
-For your convenience, the command will recognize the [environment variable](https://docs.travis-ci.com/user/environment-variables/#Defining-Variables-in-Repository-Settings) `GH_TOKEN` and will replace this pattern in the `--repo` string. Please __do NOT disable the silent mode__ if you have any credentials in the repository URL! Read more about [Github tokens here](https://help.github.com/articles/creating-an-access-token-for-command-line-use/).
-
-In example, the following command runs [on our Travis-CI](https://travis-ci.org/angular-buch/book-monkey2):
-
-```bash
-npx angular-cli-ghpages --repo=https://[email protected]/organisation/your-repo.git --name="Displayed Username" [email protected]
-```
-> You have to treat the GH_TOKEN as secure as a password!
-
-
-
-## Options
-
-#### <a id="help">--help</a>
- * Example: `npx angular-cli-ghpages --help`
-
-Output usage information.
-
-
-#### <a id="version">--version</a>
- * Example: `npx angular-cli-ghpages --version`
-
-Output the version number. Please provide the version number on any bug report!
-
-
-#### <a id="repo">--repo</a>
- * __optional__
- * Default: url of the origin remote of the current dir (assumes a git repository)
- * Example: `npx angular-cli-ghpages --repo=https://[email protected]/organisation/your-repo.git`
-
-By default, __gh-pages__ assumes that the current working directory is a git repository,
-and that you want to push changes to the `origin` remote.
-If instead your files are not in a git repository, or if you want to push to another repository,
-you can provide the repository URL in the `repo` option.
-
-
-#### <a id="message">--message</a>
- * __optional__
- * Default: `Auto-generated commit`
- * Example: `npx angular-cli-ghpages --message="What could possibly go wrong?"`
-
-The commit message, __must be wrapped in quotes__.  
-Some handy additional text is always added,
-if the environment variable `process.env.TRAVIS` exists (for Travis CI).
-
-
-#### <a id="branch">--branch</a>
- * __optional__
- * Default: `gh-pages`
- * Example: `npx angular-cli-ghpages --branch=other-branch`
- 
-The name of the branch you'll be pushing to.
-The default uses GitHub's `gh-pages` branch,
-but this can be configured to push to any branch on any remote.
-
-
-#### <a id="name">--name & --email</a>
- * __optional__
- * Default: value of `git config user.name` and `git config user.email`
- * Example: `npx angular-cli-ghpages --name="Displayed Username" [email protected]`
-
-If you are running the command in a repository without a `user.name` or `user.email` git config properties
-(or on a machine without these global config properties),
-you must provide user info before git allows you to commit.
-In this case provide both `name` and `email` string values to identify the committer.
-
-
-#### <a id="no-silent">--no-silent</a>
- * __optional__
- * Default: silent `true` (boolean)
- * Example:
-    * `npx angular-cli-ghpages` -- Logging is in silent mode by default.
-    * `npx angular-cli-ghpages --no-silent` -- Logging shows extended information.
-
-Logging is in silent mode by default.
-In silent mode log messages are suppressed and error messages are sanitized.
-
-The `--no-silent` option enables extended console logging.
-Keep this untouched if the repository URL or other information passed to git commands is sensitive!
-
-> WARNING: This option should kept like it is if the repository URL or other information passed to git commands is sensitive and should not be logged (== you have a public build server). By default the silent mode is enabled to avoid sensitive data exposure.
 
+## ⚠️ Prerequisites <a name="prerequisites"></a>
 
-#### <a id="dir">--dir</a>
- * __optional__
- * Default: `dist`
+This action has the following prerequisites:
 
-Directory for all published sources, relative to the project-root.  
-__Starting with Angular CLI 6 the build artifacts will be put in a subfolder under `dist`.
-Please take a look at the `dist` folder to see whether there is a subfolder with your project's name or not.__
+- Git 1.9 or higher (execute `git --version` to check your version)
+- Angular project created via [Angular CLI](https://github.com/angular/angular-cli)
 
-This option can be used to deploy completely different folders,
-which are not related at all to angular.
 
+## 🚀 Quick-start <a name="quickstart"></a>
 
+1. Install the next version of the Angular CLI (v8.3.0-next.0 or greater)
+   and create a new Angular project.
 
-#### <a id="no-dotfiles">--no-dotfiles</a>
- * __optional__
- * Default: dotfiles `true` (boolean)
- * Example:
-    * `npx angular-cli-ghpages` -- Dotfiles are included by default.
-    * `npx angular-cli-ghpages --no-dotfiles` -- Dotfiles are ignored.
+   ```sh
+   npm install -g @angular/cli@next
+   ng new hello-world --defaults
+   cd hello-world
+   ```
 
-The command includes dotfiles by default (e.g `.htaccess` will be committed)
-With `--no-dotfiles` files starting with `.` are ignored.
+2. Add `angular-cli-ghpages` to your project.
 
+   ```sh
+   ng add angular-cli-ghpages
+   ```
 
+3. Deploy your project to Github pages with all default settings.
+   Your project will be automatically build in production mode.
 
-#### <a id="dry-run">--dry-run</a>
- * __optional__
- * Default: `undefined`
- * Example:
-    * `npx angular-cli-ghpages` -- Normal behaviour: Changes are applied.
-    * `npx angular-cli-ghpages --dry-run` -- No changes are applied at all.
+   ```sh
+   ng run hello-world:deploy
+   ```
 
-Run through without making any changes. This can be very usefull, because it outputs what would happend without doing anything.
+## 🏁 Next milestones <a name="milestones"></a>
 
-#### <a id="cname">--cname</a>
- * __optional__
- * Default: `No CNAME file is generated`
- * Example:
-    * `npx angular-cli-ghpages --cname=example.com`
+We are glad that we have an integration into the CLI again.
+But we are looking forward to the following features:
 
-A CNAME file will be created enabling you to use a custom domain. [More information on Github Pages using a custom domain](https://help.github.com/articles/using-a-custom-domain-with-github-pages/). 
+* an interactive command-line prompt that guides you through the available options and outputs a `angular-cli-ghpages.json` file 
 
--->
+We look forward to any help. PRs are welcome!
 
-## FAQ
+## ⁉️ FAQ <a name="faq"></a>
 
 Before posting any issue, [please read the FAQ first](https://github.com/angular-schule/angular-cli-ghpages/wiki/FAQ).