Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/azure/ng-deploy-azure
Deploy Angular apps to Azure using the Angular CLI
https://github.com/azure/ng-deploy-azure
angular azure deploy schematics
Last synced: 4 days ago
JSON representation
Deploy Angular apps to Azure using the Angular CLI
- Host: GitHub
- URL: https://github.com/azure/ng-deploy-azure
- Owner: Azure
- License: mit
- Created: 2019-05-22T19:49:01.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-03T01:52:20.000Z (5 months ago)
- Last Synced: 2025-01-06T09:07:45.809Z (4 days ago)
- Topics: angular, azure, deploy, schematics
- Language: TypeScript
- Size: 249 KB
- Stars: 78
- Watchers: 9
- Forks: 40
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: License.txt
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# @azure/ng-deploy
[](https://www.npmjs.com/package/@azure/ng-deploy)
[](https://dev.azure.com/devrel/chris-noring-test/_build/latest?definitionId=19&branchName=master)
[](http://opensource.org/licenses/MIT)
**Deploy Angular apps to Azure using the Angular CLI**
`@azure/ng-deploy` helps you deploy your Angular app to Azure Static Hosting using the [Angular CLI](https://angular.io/cli).
1. Install the Angular CLI and create a new Angular project.
```sh
npm install -g @angular/cli
ng new hello-world --defaults
cd hello-world
```
2. Add `ng-deploy` to your project and create your Azure blob storage resources.
```sh
ng add @azure/ng-deploy
```
3. You may be prompted you to sign in to Azure, providing a link to open in your browser and a code to paste in the login page.
4. Deploy your project to Azure.
```sh
ng run hello-world:deploy
```
The project will be built with the production configuration (like running `ng build -c=production`).
You will see output similar to the following. Browse to the link and view your site running in Azure blob storage!
```sh
see your deployed site at https://helloworldstatic52.z22.web.core.windows.net/
```
## Requirements
You will need the Angular CLI, an Angular project, and an Azure Subscription to deploy to Azure. Details of these requirements are in this section.
### Azure
If you don't have an Azure subscription, [create your Azure free account from this link](https://azure.microsoft.com/en-us/free/?WT.mc_id=ng_deploy_azure-github-cxa).
1. Install the Angular CLI.
```sh
npm install -g @angular/cli
```
2. Run `ng --version`, make sure you have angular CLI version v14 or greater.
3. If need instructions to update the CLI, [follow these upgrade instructions](https://www.npmjs.com/package/@angular/cli#updating-angular-cli).
4. Update your project using the command:
```sh
ng update @angular/cli @angular/core
```
### An Angular App Created by the Angular CLI
You will need an Angular app created and managed by the Angular CLI. For help getting started with a new Angular app, check out the [Angular CLI](https://cli.angular.io/).
A simple app can be created with `ng new hello-world --defaults`
Verify you have TypeScript version 3.4.5 or greater in your `package.json` file of your angular project
## Details of ng-azure-deploy
### How to add and configure @azure/ng-deploy
Add _@azure/ng-deploy_ to your project by running:
```sh
ng add @azure/ng-deploy
```
This command will install the package to your project.
Once done, it will prompt you to sign in to Azure, providing a link to open in your browser and a code to paste in the login page.
After you sign in, it will create the needed resources in your Azure account (resource group and storage account) and configure them for static hosting. To manually configure the resources that will be used, refer to [additional options](#additional options).
_Note: If you have several Azure subscriptions you will be asked to choose one._
The command will create the file `azure.json` with the deployment configuration and modify `angular.json` with the deploy commands.
_Note: at the moment, the command will fail if an `azure.json` file already exists. Please remove the file before running the command._
You can deploy your application to the selected storage account by running the following command.
```sh
ng deploy
```
By default, the project will be built with the production option (similar to running `ng build -c=production`).
The files will be taken from the path configured in the `build` command in `angular.json`.
Follow [these instructions](#build-target) if you want to set up a different path and/or build target.
You may be asked to sign in to Azure again. Then, the project will be deployed to the storage account specified in `azure.json`. The link to the deployed app will be presented.
To clear the cached credentials run:
```sh
ng run :azureLogout
```
This command is available only after signing in to Azure.
This project collects usage data and sends it to Microsoft to help improve our products and services.
Read Microsoft's [privacy statement](https://privacy.microsoft.com/en-gb/privacystatement/?WT.mc_id=ng_deploy_azure-github-cxa) to learn more.
To turn off telemetry, add the telemetry flag (`--telemetry` or `-t`) with the `false` value when running `ng add`, like this:
```sh
ng add ng-deploy-azure --telemetry=false
```
or
```sh
ng add ng-deploy-azure -t=false
```
To manually select and/or create the resources needed for deployment,
use the `--manual` (or `-m`) option:
```sh
ng add @azure/ng-deploy --manual
```
You will be prompted to select or create the resource group and the storage account
in which the app will be deployed. If you choose to create a resource group
you will be asked to select the geographical location.
#### Passing configuration options
You can pass the names of the resources you'd like to use when running the command.
Resources that don't already exist will be created.
If using `--manual` you will be prompted to select the remaining configuration options.
Otherwise, defaults will be used.
The available options are:
- `--subscriptionId` (`-i`) - subscription ID under which to select and/or create new resources
- `--subscriptionName` (`-n`) - subscription name under which to select and/or create new resources
- `--resourceGroup` (`-g`) - name of the Azure Resource Group to deploy to
- `--account` (`-a`) - name of the Azure Storage Account to deploy to
- `--location` (`-l`) - location where to create storage account e.g. `"West US"` or `westus`
- `--telemetry` (`-t`) - see [Data/Telemetry](#telemetry)
Example:
```sh
ng add @azure/ng-deploy -m -l="East US" -a=myangularapp
```
When creating a new storage account, the provided name will be validated.
The requirements for these names are:
- between 3 and 24 characters
- lower case letters and numbers only
- unique across Azure
If the validation fails, the tool will suggest a valid name. You will be able to select it or try another one.
#### Changing the build target
By default, the project is built using the `build` target with the `production` configuration,
as configured in `angular.json`.
You can change this by editing the `target` and/or `configuration` in `azure.json` (after completing `@azure/ng-add`).
Change it to a target that exists for the project in `angular.json` and optionally with one of its configurations.
Make sure the target specifies an `outputPath`.
For example, if one of the targets under `projects.hello-world.architect` in `angular.json` is `special-build`
with an optional configuration named `staging`, you can specify it as the target this way:
```json
// azure.json
{
"hosting": [
{
"app": {
"project": "hello-world",
"target": "special-build",
"configuration": "staging"
},
"azureHosting": {
...
}
}
]
}
```
Another option is to skip build, and deploy directly from a specific location.
To do this, delete the `target` and `configuration` from `azure.json`,
and provide a `path` with a value relative to the root of the project.
For example, if the files you with to deploy exist in `public/static/hello-world`,
change the configuration this way:
```json
// azure.json
{
"hosting": [
{
"app": {
"project": "hello-world",
"path": "public/static/hello-world"
},
"azureHosting": {
...
}
}
]
}
```
In the future we'll add an option to change this through the command line.
## Continuous Integration Mode
When deploying from a CI environment, we switch to a non-interactive login process that requires
you to provide [Service Principal](https://docs.microsoft.com/en-us/azure/active-directory/develop/app-objects-and-service-principals?WT.mc_id=ng_deploy_azure-github-cxa) credentials as environment variables.
A Service Principal is an application within [Azure Active Directory](https://docs.microsoft.com/en-us/azure/active-directory/fundamentals/active-directory-whatis?WT.mc_id=ng_deploy_azure-github-cxa)
that we can use to perform unattended resource and service level operations.
### Creating a Service Principal
In order to create and get the Service Principal application credentials, you can either use the
[Azure Portal](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal?WT.mc_id=ng_deploy_azure-github-cxa)
or use the [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest?WT.mc_id=ng_deploy_azure-github-cxa).
We recommend using the Azure CLI and running the following command:
```sh
AZURE_SUBSCRIPTION_ID=""
SP_NAME=''
az ad sp create-for-rbac --role="Contributor" --scopes="/subscriptions/$AZURE_SUBSCRIPTION_ID" --name="$SP_NAME"
```
This command will output the following values:
```json
{
"appId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"displayName": "",
"name": "http://",
"password": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"tenant": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```
You can use the Azure CLI to test that these values work and you can log in:
```sh
az login --service-principal -u $CLIENT_ID -p $CLIENT_SECRET --tenant $TENANT_ID
```
### Configuring the environment variables
We will need to set the following environment variables BEFORE adding `@azure/ng-deploy` or running the deploy command:
- `CI`: this must be set to `1`. This will enable the CI mode.
- `CLIENT_ID`: is the `appId` created above.
- `CLIENT_SECRET`: is the `password` created above.
- `TENANT_ID`: is the `tenant` created above.
- `AZURE_SUBSCRIPTION_ID`: is your valid subscription ID.
Here is a simple shell example:
```sh
export CI=1
export CLIENT_ID='xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
export CLIENT_SECRET='xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
export TENANT_ID='xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
export AZURE_SUBSCRIPTION_ID="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
ng run :deploy
```
> For security reasons, we highly recommend to create and provide these environment variables through a different method,
> eg. [Github Secrets](https://help.github.com/en/articles/virtual-environments-for-github-actions#environment-variables)
> or [Azure DevOps Secrets](https://docs.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch#secret-variables?WT.mc_id=ng_deploy_azure-github-cxa).
Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) at [[email protected]](mailto:[email protected]).
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message.
Further information, including the [MSRC PGP](https://technet.microsoft.com/en-us/security/dn606155/?WT.mc_id=ng_deploy_azure-github-cxa) key,
can be found in the [Security TechCenter](https://technet.microsoft.com/en-us/security/default/?WT.mc_id=ng_deploy_azure-github-cxa).
## Contributing
Please refer to [CONTRIBUTING](CONTRIBUTING.md) for CLA guidance.
## Thank You
- [Minko Gechev](https://twitter.com/mgechev) for guiding us through the new Angular CLI Architect API, which enables adding commands.
- [Brian Holt](https://twitter.com/holtbt) for creating [azez](https://github.com/btholt/azez), which provided us an (az)easy start.
- [John Papa](https://twitter.com/john_papa) for guiding through and supporting the development, publish and release.
## Related Resources
- Learn more about Azure Static Hosting in this [blog post announcing Static websites on Azure Storage](https://azure.microsoft.com/en-us/blog/static-websites-on-azure-storage-now-generally-available/?WT.mc_id=ng_deploy_azure-github-cxa)
- Install this [VS Code extension for Azure Storage](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azurestorage&WT.mc_id=ng_deploy_azure-github-cxa)
- Follow this tutorial to [deploy a static website to Azure](https://code.visualstudio.com/tutorials/static-website/getting-started?WT.mc_id=ng_deploy_azure-github-cxa)
[azure-cli]: https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest?WT.mc_id=ng_deploy_azure-github-cxa
[active-directory]: https://docs.microsoft.com/en-us/azure/active-directory/fundamentals/active-directory-whatis?WT.mc_id=ng_deploy_azure-github-cxa
[principal-service]: https://docs.microsoft.com/en-us/azure/active-directory/develop/app-objects-and-service-principals?WT.mc_id=ng_deploy_azure-github-cxa
[principal-service-portal]: https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal?WT.mc_id=ng_deploy_azure-github-cxa
[azure-devops-secrets]: https://docs.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch#secret-variables?WT.mc_id=ng_deploy_azure-github-cxa
[github-secrets]: https://help.github.com/en/articles/virtual-environments-for-github-actions#environment-variables