Add readme

Author: mgechev

.gitignore

@@ -6,6 +6,7 @@ app/bower_components
 .bash_history
 *.swp
 *.swo
+*.d.ts
 
 *.classpath
 *.project
@@ -21,4 +22,3 @@ nvim/doc
 nvim/swaps
 nvim/colors
 dist
-

README.md

@@ -0,0 +1,33 @@
+# Angular CLI Deployment to GitHub Pages
+
+Deploy your Angular app to GitHub pages directly from the Angular CLI! 🚀
+
+## How to use?
+
+```
+ng add ngx-gh
+ng run [PROJECT_NAME]:deploy
+```
+
+## Options
+
+If you're deploying your application to `https://[USERNAME].github.io/[PROJECT_NAME]`, you'd have to set the following options:
+
+- `--deployUrl` - specifies the URL you're deploying your application to. For example `https://mgechev.github.io/codelyzer/`.
+- `--baseHref` - specifies the `baseHref` and used by the Angular router. For the example above, the `baseHref` would be `/codelyzer/`.
+
+Sample invocation:
+
+```
+ng run codelyzer:deploy --baseHref /codelyzer/ --deployUrl https://mgechev.github.io/codelyzer/
+```
+
+Deployment to the root of a custom domain may not require any of the listed flags below.
+
+## Configuring the build
+
+Since `ng deploy` will automatically invoke the production build of your app, you can configure it using the workspace configuration file `angular.json`. You can find the build config under: `projects.[PROJECT_NAME].architect.build.configuration.production`.
+
+## License
+
+MIT

deploy/actions.ts

@@ -1,28 +1,35 @@
 import { BuilderContext } from '@angular-devkit/architect';
 import { GHPages } from '../interfaces';
+import { Schema as RealDeployOptions } from './schema';
+import { json } from '@angular-devkit/core';
+type DeployOptions = RealDeployOptions & json.JsonObject;
 
 export default async function deploy(
   ghPages: GHPages,
   context: BuilderContext,
-  projectRoot: string
+  projectRoot: string,
+  options: DeployOptions
 ) {
   if (!context.target) {
     throw new Error('Cannot execute the build target');
   }
 
   context.logger.info(`📦 Building "${context.target.project}"`);
 
-  const run = await context.scheduleTarget({
-    target: 'build',
-    project: context.target.project,
-    configuration: 'production'
-  });
+  const run = await context.scheduleTarget(
+    {
+      target: 'build',
+      project: context.target.project,
+      configuration: 'production'
+    },
+    options
+  );
   await run.result;
 
   try {
     await ghPages.publish(projectRoot, {});
     context.logger.info(
-      `🚀 Your application is now available at https://${''}.firebaseapp.com/`
+      `🚀 Your application is now available at ${options.deployUrl}`
     );
   } catch (e) {
     context.logger.error(e);

deploy/builder.ts

@@ -5,13 +5,19 @@ import {
 } from '@angular-devkit/architect';
 import { NodeJsSyncHost } from '@angular-devkit/core/node';
 import deploy from './actions';
-import { experimental, join, normalize } from '@angular-devkit/core';
+import { experimental, join, normalize, json } from '@angular-devkit/core';
+import { Schema as RealDeployOptions } from './schema';
+type DeployOptions = RealDeployOptions & json.JsonObject;
+
 const ghpages = require('gh-pages');
 
 // Call the createBuilder() function to create a builder. This mirrors
 // createJobHandler() but add typings specific to Architect Builders.
 export default createBuilder<any>(
-  async (_: any, context: BuilderContext): Promise<BuilderOutput> => {
+  async (
+    options: DeployOptions,
+    context: BuilderContext
+  ): Promise<BuilderOutput> => {
     // The project root is added to a BuilderContext.
     const root = normalize(context.workspaceRoot);
     const workspace = new experimental.workspace.Workspace(
@@ -41,11 +47,11 @@ export default createBuilder<any>(
       await deploy(
         ghpages,
         context,
-        join(workspace.root, targets.build.options.outputPath)
+        join(workspace.root, targets.build.options.outputPath),
+        options
       );
     } catch (e) {
-      console.error('Error when trying to deploy: ');
-      console.error(e.message);
+      console.error('Error when trying to deploy: ', e.message);
       return { success: false };
     }
 

deploy/schema.json

@@ -1,6 +1,15 @@
 {
-  "id": "GHPagesDeploySchema",
-  "title": "GH pages deploy",
-  "description": "TBD",
-  "properties": {}
+  "id": "Schema",
+  "title": "schema",
+  "description": "Deployment of Angular CLI applications to GitHub pages",
+  "properties": {
+    "baseHref": {
+      "type": "string",
+      "description": "Base url for the application being built."
+    },
+    "deployUrl": {
+      "type": "string",
+      "description": "URL where files will be deployed."
+    }
+  }
 }

package.json

@@ -4,7 +4,7 @@
   "description": "Deployment from the Angular CLI to GitHub pages",
   "main": "index.js",
   "scripts": {
-    "build": "rm -rf dist && tsc && cp builders.json collection.json package.json dist && cp deploy/schema.json dist/deploy",
+    "build": "rm -rf dist && json2ts deploy/schema.json > deploy/schema.d.ts && tsc && cp README.md builders.json collection.json package.json dist && cp deploy/schema.json dist/deploy",
     "test": "jest"
   },
   "schematics": "./collection.json",
@@ -34,13 +34,14 @@
     "@types/jest": "^24.0.15",
     "@types/node": "^12.0.10",
     "jest": "^24.8.0",
+    "json-schema-to-typescript": "^6.1.3",
     "ts-jest": "^24.0.2",
     "typescript": "^3.5.2"
   },
   "peerDependencies": {
-    "@angular-devkit/architect": "^0.800.6",
-    "@angular-devkit/core": "^8.0.6",
-    "@angular-devkit/schematics": "^8.0.6"
+    "@angular-devkit/architect": ">=0.800.0",
+    "@angular-devkit/core": ">=8.0.0",
+    "@angular-devkit/schematics": ">=8.0.0"
   },
   "dependencies": {
     "gh-pages": "^2.0.1"