angular-cli-ghpages/deploy/schema.json

Deploy your Angular app to GitHub Pages or Cloudflare Pages directly from the Angular CLI (ng deploy)

{
  "$id": "Schema",
  "title": "schema",
  "description": "Deployment of Angular CLI applications to GitHub pages (angular-cli-ghpages)",
  "properties": {
    "baseHref": {
      "type": "string",
      "description": "Base url for the application being built. Same as `ng build --base-href=/XXX/`."
    },
    "buildTarget": {
      "type": "string",
      "description": "A named build target, as specified in the `configurations` section of angular.json. Each named target is accompanied by a configuration of option defaults for that target. This is equivalent to calling the command `ng build --configuration=XXX`."
    },
    "prerenderTarget": {
      "type": "string",
      "description": "Architect target for prerendering/SSG. Takes precedence over buildTarget when specified. Requires a prerender target configured in angular.json."
    },
    "noBuild": {
      "type": "boolean",
      "default": false,
      "description": "Skip build process during deployment."
    },
    "remote": {
      "type": "string",
      "description": "Provide the remote name. If no value is provided, `origin` is used. Has no function if --repo is set.",
      "default": "origin"
    },
    "repo": {
      "type": "string",
      "description": "Provide the repository URL. If no value is provided, a remote of the current working directory is used (defaults to `origin`; see --remote for details)."
    },
    "message": {
      "type": "string",
      "description": "The commit message.",
      "default": "Auto-generated commit"
    },
    "branch": {
      "type": "string",
      "description": "The git branch to push your pages to.",
      "default": "gh-pages"
    },
    "name": {
      "type": "string",
      "description": "The git user-name which is associated with this commit."
    },
    "email": {
      "type": "string",
      "description": "The git user-email which is associated with this commit."
    },
    "noSilent": {
      "type": "boolean",
      "description": "Deprecated! This parameter is no longer needed. It will be ignored.",
      "default": false
    },
    "noDotfiles": {
      "type": "boolean",
      "description": "Exclude dotfiles (files starting with `.`) from deployment.",
      "default": false
    },
    "noNotfound": {
      "type": "boolean",
      "description": "By default a 404.html file is created for SPA routing on GitHub Pages. For Cloudflare Pages, you must use --no-notfound to enable native SPA routing.",
      "default": false
    },
    "noNojekyll": {
      "type": "boolean",
      "description": "Skip creating the .nojekyll file.",
      "default": false
    },
    "cname": {
      "type": "string",
      "description": "Generate a CNAME file for the specified domain.",
      "default": ""
    },
    "add": {
      "type": "boolean",
      "description": "Only add, and never remove existing files from the GitHub pages branch.",
      "default": false
    },
    "dir": {
      "type": "string",
      "description": "Overrides the directory for all published sources, relative to the current working directory.",
      "default": ""
    },
    "dryRun": {
      "type": "boolean",
      "description": "For testing: Run through without making any changes. Execute with --dry-run and nothing will happen.",
      "default": false
    }
  }
}