\href{https://www.npmjs.com/package/angular-cli-ghpages}{\texttt{ }} \href{https://circleci.com/gh/angular-schule/angular-cli-ghpages}{\texttt{ }} \href{http://opensource.org/licenses/MIT}{\texttt{ }}

{\bfseries{Deploy your Angular app to Git\+Hub pages directly from the Angular CLI! 🚀}}



{\bfseries{Table of contents\+:}}


\begin{DoxyEnumerate}
\item \href{\#changelog}{\texttt{ 📖 Changelog}}
\item \href{\#prerequisites}{\texttt{ ⚠️ Prerequisites}}
\item \href{\#quickstart-local}{\texttt{ 🚀 Quick Start (local development)}}
\item \href{\#continuous-delivery}{\texttt{ 🚀 Continuous Delivery}}
\item \href{\#options}{\texttt{ 📦 Options}}
\begin{DoxyItemize}
\item \href{\#base-href}{\texttt{ --base-\/href}}
\item \href{\#configuration}{\texttt{ --configuration}}
\item \href{\#no-build}{\texttt{ --no-\/build}}
\item \href{\#repo}{\texttt{ --repo}}
\item \href{\#message}{\texttt{ --message}}
\item \href{\#branch}{\texttt{ --branch}}
\item \href{\#name}{\texttt{ --name \& --email}}
\item \href{\#no-silent}{\texttt{ --no-\/silent}}
\item \href{\#no-dotfiles}{\texttt{ --no-\/dotfiles}}
\item \href{\#cname}{\texttt{ --cname}}
\item \href{\#dry-run}{\texttt{ --dry-\/run}}
\end{DoxyItemize}
\item \href{\#configuration-file}{\texttt{ 📁 Configuration File}}
\item \href{\#environments}{\texttt{ 🌍 Environments}}
\item \href{\#faq}{\texttt{ ⁉️ FAQ}}
\end{DoxyEnumerate}

\DoxyHorRuler{0}
\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2951}{}\doxysection{📖 Changelog $<$a name=\char`\"{}changelog\char`\"{}$>$$<$/a$>$}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2951}
A detailed changelog is available in the \href{https://github.com/angular-schule/angular-cli-ghpages/releases}{\texttt{ releases}} section.

The latest version comes with enhanced error handling and a progress report\+:

\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2952}{}\doxysection{⚠️ Prerequisites $<$a name=\char`\"{}prerequisites\char`\"{}$>$$<$/a$>$}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2952}
This command has the following prerequisites\+:


\begin{DoxyItemize}
\item Git 1.\+9 or higher (execute {\ttfamily git -\/-\/version} to check your version)
\item Angular project created via \href{https://github.com/angular/angular-cli}{\texttt{ Angular CLI}} v8.\+3.\+0 or greater (execute {\ttfamily ng update @angular/cli @angular/core} to upgrade your project if necessary)
\item older Angular projects can still use the standalone program. See the documentation at \href{https://github.com/angular-schule/angular-cli-ghpages/blob/master/docs/README_standalone.md}{\texttt{ README\+\_\+standalone}}.
\end{DoxyItemize}\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2953}{}\doxysection{🚀 Quick Start (local development) $<$a name=\char`\"{}quickstart-\/local\char`\"{}$>$$<$/a$>$}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2953}
This quick start assumes that you are starting from scratch. If you already have an existing Angular project on Git\+Hub, skip step 1 and 2.


\begin{DoxyEnumerate}
\item Install the latest version of the Angular CLI (v8.\+3.\+0 or greater) globally and create a new Angular project.
\end{DoxyEnumerate}


\begin{DoxyCode}{0}
\DoxyCodeLine{npm install -\/g @angular/cli}
\DoxyCodeLine{ng new your-\/angular-\/project -\/-\/defaults}
\DoxyCodeLine{cd your-\/angular-\/project}

\end{DoxyCode}



\begin{DoxyEnumerate}
\item By default the Angular CLI initializes a Git repository for you. ~\newline
 To add a new remote for Git\+Hub, use the {\ttfamily git remote add} command\+:
\end{DoxyEnumerate}


\begin{DoxyCode}{0}
\DoxyCodeLine{git remote add origin https://github.com/<username>/<repositoryname>.git}

\end{DoxyCode}


Hints\+:


\begin{DoxyItemize}
\item Create a new empty Git\+Hub repository first.
\item Replace {\ttfamily $<$username$>$} and {\ttfamily $<$repositoryname$>$} with your username from Git\+Hub and the name of your new repository.
\item Please enter the URL {\ttfamily \href{https://github.com/}{\texttt{ https\+://github.\+com/}}$<$username$>$/$<$repositoryname$>$.git} into your browser – you should see your existing repository on Git\+Hub.
\item Please double-\/check that you have the necessary rights to make changes to the given project!
\end{DoxyItemize}

Add {\ttfamily angular-\/cli-\/ghpages} to your project.


\begin{DoxyCode}{0}
\DoxyCodeLine{ng add angular-\/cli-\/ghpages}

\end{DoxyCode}



\begin{DoxyEnumerate}
\item Deploy your project to Git\+Hub pages with all default settings. Your project will be automatically built in production mode.
\end{DoxyEnumerate}


\begin{DoxyCode}{0}
\DoxyCodeLine{ng deploy}

\end{DoxyCode}


Which is the same as\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{ng deploy your-\/angular-\/project}

\end{DoxyCode}



\begin{DoxyEnumerate}
\item Your project should be available at {\ttfamily \href{https://}{\texttt{ https\+://}}$<$username$>$.github.\+io/$<$repositoryname$>$}. ~\newline
 Learn more about Git\+Hub pages on the \href{https://pages.github.com/}{\texttt{ official website}}.
\end{DoxyEnumerate}\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2954}{}\doxysection{🚀 Continuous Delivery $<$a name=\char`\"{}continuous-\/delivery\char`\"{}$>$$<$/a$>$}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2954}
If you run this command from a CI/\+CD environment, the deployment will most likely not work out of the box. For security reasons, those environments usually have read-\/only privileges or you haven\textquotesingle{}t set up Git correctly. Therefore you should take a look at \href{https://help.github.com/articles/creating-an-access-token-for-command-line-use/}{\texttt{ \char`\"{}personal access tokens\char`\"{} {\ttfamily GH\+\_\+\+TOKEN}}} (which works everywhere) and the \href{https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token}{\texttt{ \char`\"{}installation access token\char`\"{} {\ttfamily GITHUB\+\_\+\+TOKEN}}} (which is exclusively provided by Git\+Hub actions). In short\+: a token replaces username and password and is a safer choice because a token can be revoked at any time.

All you need to do is to set an environment variable called {\ttfamily GH\+\_\+\+TOKEN} (or {\ttfamily PERSONAL\+\_\+\+TOKEN}) in your CI/\+CD environment. For Git\+Hub Actions, you can also use the {\ttfamily GITHUB\+\_\+\+TOKEN} which provides more security and requires no additional setup. All the tokens only work if the remote repository uses the HTTPS scheme. Tokens are generally not supported for Git over SSH.

If the current working directory is already a git repository, you don\textquotesingle{}t need to specify the repository again. The current remote repository with the name {\ttfamily origin} will be used in this case. You can also override the repository setting using the {\ttfamily -\/-\/repo} option.

If you specify all the three options ({\ttfamily -\/-\/repo}, {\ttfamily -\/-\/name} and {\ttfamily -\/-\/email}), then angular-\/cli-\/ghpages will also work in directories that are not under version control at all.


\begin{DoxyCode}{0}
\DoxyCodeLine{ng deploy -\/-\/repo=https://github.com/<username>/<repositoryname>.git -\/-\/name="{}Your Git Username"{} -\/-\/email=your.mail@example.org }

\end{DoxyCode}


(replace {\ttfamily $<$username$>$} and {\ttfamily $<$repositoryname$>$} with your username from Git\+Hub and the name of your repository)

\begin{quote}
Please {\bfseries{do not disable the silent mode}} if you use tokens, otherwise people could read them in the output logs. If you are sure that your CI/\+CD provider does not display secrets on the console (this applies to Circle\+CI / Travis CI and Github Actions), you are welcome to disable silent mode. \end{quote}
\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2955}{}\doxysection{📦 Options $<$a name=\char`\"{}options\char`\"{}$>$$<$/a$>$}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2955}
\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2956}{}\doxysubsubsection{–base-\/href $<$a name=\char`\"{}base-\/href\char`\"{}$>$$<$/a$>$}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2956}

\begin{DoxyItemize}
\item {\bfseries{optional}}
\item Default\+: {\ttfamily undefined} (string)
\item Example\+:
\begin{DoxyItemize}
\item {\ttfamily ng deploy} – The tag {\ttfamily $<$base href=\char`\"{}/\char`\"{}$>$} remains unchanged in your {\ttfamily index.\+html}
\item {\ttfamily ng deploy -\/-\/base-\/href=/the-\/repositoryname/} – The tag {\ttfamily $<$base href=\char`\"{}/the-\/repositoryname/\char`\"{}$>$} is added to your {\ttfamily index.\+html}
\end{DoxyItemize}
\end{DoxyItemize}

Specifies the base URL for the application being built. Same as {\ttfamily ng build -\/-\/base-\/href=/\+XXX/}

{\bfseries{ℹ️ Please read the next lines carefully, or you will get 404 errors in case of a wrong configuration!}}\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2957}{}\doxyparagraph{A) You don\textquotesingle{}t want to use a custom domain}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2957}
If you don\textquotesingle{}t want to use an own domain, then your later URL of your hosted Angular project should look like this\+: {\ttfamily \href{https://your-username.github.io/the-repositoryname}{\texttt{ https\+://your-\/username.\+github.\+io/the-\/repositoryname}}}. In this case you have to adjust the {\ttfamily -\/-\/base-\/href} accordingly\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{ng deploy -\/-\/base-\/href=/the-\/repositoryname/ }

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2958}{}\doxyparagraph{B) You want to use a custom domain}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2958}
If you want to use your own domain, then you don\textquotesingle{}t have to adjust {\ttfamily -\/-\/base-\/href}. However, it is now necessary to set the {\ttfamily -\/-\/cname} parameter!


\begin{DoxyCode}{0}
\DoxyCodeLine{ng deploy -\/-\/cname=example.org }

\end{DoxyCode}


See the option \href{\#cname}{\texttt{ --cname}} for more information!\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2959}{}\doxysubsubsection{–configuration $<$a name=\char`\"{}configuration\char`\"{}$>$$<$/a$>$}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2959}

\begin{DoxyItemize}
\item {\bfseries{optional}}
\item Alias\+: {\ttfamily -\/c}
\item Default\+: {\ttfamily production} (string)
\item Example\+:
\begin{DoxyItemize}
\item {\ttfamily ng deploy} – Angular project is build in production mode
\item {\ttfamily ng deploy -\/-\/configuration=test} – Angular project is using the configuration {\ttfamily test} (this configuration must exist in the {\ttfamily angular.\+json} file)
\end{DoxyItemize}
\end{DoxyItemize}

A named build target, as specified in the {\ttfamily configurations} section of {\ttfamily angular.\+json}. Each named target is accompanied by a configuration of option defaults for that target. Same as {\ttfamily ng build -\/-\/configuration=XXX}. This command has no effect if the option {\ttfamily -\/-\/no-\/build} option is active.\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2960}{}\doxysubsubsection{–no-\/build $<$a name=\char`\"{}no-\/build\char`\"{}$>$$<$/a$>$}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2960}

\begin{DoxyItemize}
\item {\bfseries{optional}}
\item Default\+: {\ttfamily false} (string)
\item Example\+:
\begin{DoxyItemize}
\item {\ttfamily ng deploy} – Angular project is build in production mode before the deployment
\item {\ttfamily ng deploy -\/-\/no-\/build} – Angular project is NOT build
\end{DoxyItemize}
\end{DoxyItemize}

Skip build process during deployment. This can be used when you are sure that you haven\textquotesingle{}t changed anything and want to deploy with the latest artifact. This command causes the {\ttfamily -\/-\/configuration} setting to have no effect.\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2961}{}\doxysubsubsection{–repo $<$a name=\char`\"{}repo\char`\"{}$>$$<$/a$>$}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2961}

\begin{DoxyItemize}
\item {\bfseries{optional}}
\item Default\+: URL of the origin remote of the current dir (assumes a Git repository)
\item Example\+: {\ttfamily ng deploy -\/-\/repo=\href{https://github.com/}{\texttt{ https\+://github.\+com/}}$<$username$>$/$<$repositoryname$>$.git}
\end{DoxyItemize}

This specifies the target repository. If none is given as an option, the repository is discovered from the current working directory.

By default, this command assumes that the current working directory is a Git repository, and that you want to push changes to the {\ttfamily 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 {\ttfamily repo} option.

\begin{quote}
{\bfseries{ℹ️ Hint\+:}} Set an environment variable with the name {\ttfamily GH\+\_\+\+TOKEN} / {\ttfamily PERSONAL\+\_\+\+TOKEN} or {\ttfamily GITHUB\+\_\+\+TOKEN} and it will be automatically added to the URL, if it uses the HTTPS shema (it must start with {\ttfamily \href{https://github.com}{\texttt{ https\+://github.\+com}}}). Tokens are generally not supported for Git over SSH (starts with {\ttfamily git@github.\+com}). \end{quote}
Learn more about \href{https://help.github.com/articles/creating-an-access-token-for-command-line-use/}{\texttt{ \char`\"{}personal access tokens\char`\"{} here}} ({\ttfamily GH\+\_\+\+TOKEN}) and about the \href{https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token}{\texttt{ \char`\"{}installation access token\char`\"{} here}} ({\ttfamily GITHUB\+\_\+\+TOKEN}). {\ttfamily PERSONAL\+\_\+\+TOKEN} is an alias for {\ttfamily GH\+\_\+\+TOKEN}.\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2962}{}\doxysubsubsection{–message $<$a name=\char`\"{}message\char`\"{}$>$$<$/a$>$}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2962}

\begin{DoxyItemize}
\item {\bfseries{optional}}
\item Default\+: {\ttfamily Auto-\/generated commit} (string)
\item Example\+: {\ttfamily ng deploy -\/-\/message=\char`\"{}\+What could possibly go wrong?\char`\"{}}
\end{DoxyItemize}

The commit message {\bfseries{must be wrapped in quotes}} if there are any spaces in the text. ~\newline
 Some additional text is always added to the message, if the command runs on Travis CI, Circle CI or Git\+Hub Actions.\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2963}{}\doxysubsubsection{–branch $<$a name=\char`\"{}branch\char`\"{}$>$$<$/a$>$}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2963}

\begin{DoxyItemize}
\item {\bfseries{optional}}
\item Default\+: {\ttfamily gh-\/pages} (string)
\item Example\+: {\ttfamily ng deploy -\/-\/branch=master}
\end{DoxyItemize}

The name of the branch you\textquotesingle{}ll be pushing to. The default uses Git\+Hub\textquotesingle{}s {\ttfamily gh-\/pages} branch, but this can be configured to push to any branch on any remote. You have to change this to {\ttfamily master} if you are pushing to a Git\+Hub organization page (instead of a Git\+Hub user page).\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2964}{}\doxysubsubsection{–name \& –email $<$a name=\char`\"{}name\char`\"{}$>$$<$/a$>$}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2964}

\begin{DoxyItemize}
\item {\bfseries{optional}}
\item Default\+: value of {\ttfamily git config user.\+name} and {\ttfamily git config user.\+email}
\item Example\+: {\ttfamily ng deploy -\/-\/name=\char`\"{}\+Displayed Username\char`\"{} -\/-\/email=mail@example.\+org}
\end{DoxyItemize}

If you run the command in a repository without {\ttfamily user.\+name} or {\ttfamily 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 {\bfseries{both}} {\ttfamily name} and {\ttfamily email} string values to identify the committer.\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2965}{}\doxysubsubsection{–no-\/silent $<$a name=\char`\"{}no-\/silent\char`\"{}$>$$<$/a$>$}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2965}

\begin{DoxyItemize}
\item {\bfseries{optional}}
\item Default\+: silent {\ttfamily true} (boolean)
\item Example\+:
\begin{DoxyItemize}
\item {\ttfamily ng deploy} – Logging is in silent mode by default.
\item {\ttfamily ng deploy -\/-\/no-\/silent} – Logging shows extended information.
\end{DoxyItemize}
\end{DoxyItemize}

Logging is in silent mode by default. In silent mode, the error messages for git operations are always sanitized. (The message is always\+: `\textquotesingle{}Unspecified error (run without silent option for detail)'\`{})

The {\ttfamily -\/-\/no-\/silent} option enables detailed error messages and extended console logging. Keep this untouched if the repository URL or other information passed to git commands is sensitive!

\begin{quote}
{\bfseries{⚠️ WARNING\+:}} This option should be kept as 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 and you are using the token feature). By default the silent mode is enabled to avoid sensitive data exposure. \end{quote}
\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2966}{}\doxysubsubsection{–no-\/dotfiles $<$a name=\char`\"{}no-\/dotfiles\char`\"{}$>$$<$/a$>$}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2966}

\begin{DoxyItemize}
\item {\bfseries{optional}}
\item Default\+: dotfiles {\ttfamily true} (boolean)
\item Example\+:
\begin{DoxyItemize}
\item {\ttfamily ng deploy} – Dotfiles are included by default.
\item {\ttfamily ng deploy -\/-\/no-\/dotfiles} – Dotfiles are ignored.
\end{DoxyItemize}
\end{DoxyItemize}

The command includes dotfiles by default (e.\+g. {\ttfamily .htaccess} will be committed). With {\ttfamily -\/-\/no-\/dotfiles} files starting with {\ttfamily .} are ignored.

{\bfseries{Hint\+:}} This is super useful if you want to publish a {\ttfamily .nojekyll} file. Create such a file in the root of your pages repo to bypass the Jekyll static site generator on Git\+Hub Pages. Static content is still delivered – even without Jekyll. This should only be necessary if your site uses files or directories that start with $\ast$$\ast$\+\_\+underscores$\ast$$\ast$ since Jekyll considers these to be special resources and does not copy them to the final site. → Or just don\textquotesingle{}t use underscores!\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2967}{}\doxysubsubsection{–cname $<$a name=\char`\"{}cname\char`\"{}$>$$<$/a$>$}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2967}

\begin{DoxyItemize}
\item {\bfseries{optional}}
\item Default\+: {\ttfamily undefined} (string) – No CNAME file is generated
\item Example\+:
\begin{DoxyItemize}
\item {\ttfamily ng deploy -\/-\/cname=example.\+com}
\end{DoxyItemize}
\end{DoxyItemize}

A CNAME file will be created enabling you to use a custom domain. \href{https://help.github.com/articles/using-a-custom-domain-with-github-pages/}{\texttt{ More information on Git\+Hub Pages using a custom domain}}.\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2968}{}\doxysubsubsection{–dry-\/run $<$a name=\char`\"{}dry-\/run\char`\"{}$>$$<$/a$>$}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2968}

\begin{DoxyItemize}
\item {\bfseries{optional}}
\item Default\+: {\ttfamily false} (boolean)
\item Example\+:
\begin{DoxyItemize}
\item {\ttfamily ng deploy} – Normal behavior\+: Changes are applied.
\item {\ttfamily ng deploy -\/-\/dry-\/run} – No changes are applied at all.
\end{DoxyItemize}
\end{DoxyItemize}

Run through without making any changes. This can be very useful because it outputs what would happen without doing anything.\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2969}{}\doxysection{📁 Configuration File $<$a name=\char`\"{}configuration-\/file\char`\"{}$>$$<$/a$>$}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2969}
To avoid all these command-\/line cmd options, you can write down your configuration in the {\ttfamily angular.\+json} file in the {\ttfamily options} attribute of your deploy project\textquotesingle{}s architect. Just change the kebab-\/case to lower camel case. This is the notation of all options in lower camel case\+:


\begin{DoxyItemize}
\item base\+Href
\item configuration
\item no\+Build
\item repo
\item message
\item branch
\item name
\item email
\item no\+Silent
\item no\+Dotfiles
\item cname
\item dry\+Run
\end{DoxyItemize}

A list of all avaiable options is also available \href{https://github.com/angular-schule/angular-cli-ghpages/blob/master/src/deploy/schema.json}{\texttt{ here}}.

Example\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{ng deploy -\/-\/base-\/href=https://angular-\/schule.github.io/angular-\/cli-\/ghpages/ -\/-\/name="{}Angular Schule Team"{} -\/-\/email=team@angular.schule }

\end{DoxyCode}


becomes


\begin{DoxyCode}{0}
\DoxyCodeLine{"{}deploy"{}: \{}
\DoxyCodeLine{  "{}builder"{}: "{}angular-\/cli-\/ghpages:deploy"{},}
\DoxyCodeLine{  "{}options"{}: \{}
\DoxyCodeLine{    "{}baseHref"{}: "{}https://angular-\/schule.github.io/angular-\/cli-\/ghpages/"{},}
\DoxyCodeLine{    "{}name"{}: "{}Angular Schule Team"{},}
\DoxyCodeLine{    "{}email"{}: "{}team@angular.schule"{}}
\DoxyCodeLine{  \}}
\DoxyCodeLine{\} }

\end{DoxyCode}


And just run {\ttfamily ng deploy} 😄.

\begin{quote}
{\bfseries{ℹ️ Hint\+:}} You can always use the \href{\#dry-run}{\texttt{ --dry-\/run}} option to verify if your configuration is right. \end{quote}
\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2970}{}\doxysection{🌍 Environments $<$a name=\char`\"{}environments\char`\"{}$>$$<$/a$>$}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2970}
We have seen {\ttfamily angular-\/cli-\/ghpages} running on various environments, like Travis CI, Circle\+Ci or Github Actions. Please share your knowledge by writing an article about how to set up the deployment.


\begin{DoxyEnumerate}
\item \href{https://github.com/angular-schule/angular-cli-ghpages/blob/master/docs/README_environment_github_actions.md}{\texttt{ Git\+Hub Actions}} by \href{https://github.com/shhdharmen}{\texttt{ Dharmen Shah}}
\item TODO\+: Travis CI
\item TODO\+: Circle\+CI
\end{DoxyEnumerate}\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2971}{}\doxysection{⁉️ FAQ $<$a name=\char`\"{}faq\char`\"{}$>$$<$/a$>$}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2971}
Before posting any issue, \href{https://github.com/angular-schule/angular-cli-ghpages/wiki/FAQ}{\texttt{ please read the FAQ first}}. See the contributors documentation at \href{https://github.com/angular-schule/angular-cli-ghpages/blob/master/docs/README_contributors.md}{\texttt{ README\+\_\+contributors}} if you want to debug and test this project.\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2972}{}\doxysection{License $<$a name=\char`\"{}license\char`\"{}$>$$<$/a$>$}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2972}
Code released under the \mbox{[}MIT license\mbox{]}(LICENSE).

\DoxyHorRuler{0}
\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2973}{}\doxysection{🚀 Powered by $<$a href=\char`\"{}https\+://github.\+com/angular-\/schule/ngx-\/deploy-\/starter\char`\"{}$>$ngx-\/deploy-\/starter$<$/a$>$}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2973}
\hypertarget{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2974}{}\doxysubsection{© 2019 https\+://angular.\+schule}\label{md_sfcode_node_modules_angular_cli_ghpages_README_autotoc_md2974}
This project is made on top of \href{https://github.com/tschaub/gh-pages}{\texttt{ tschaub/gh-\/pages}}. ~\newline
 Thank you very much for this great foundation! 