README.md

GitHub Action for Azure Resource Manager (ARM) deployment

A GitHub Action to deploy ARM templates.

Dependencies

• Checkout To checks-out your repository so the workflow can access any specified ARM template.

Inputs

• creds Required
  Create Service Principal for Authentication

• resourceGroupName Required
  Provide the name of a resource group.

• templateLocation Required
  Specify the path to the Azure Resource Manager template.
  (See assets/json/template.json)

• deploymentMode
  Incremental (only add resources to resource group) or Complete (remove extra resources from resource group). Default: Incremental.

• deploymentName
  Specifies the name of the resource group deployment to create.

• parameters
  Specify the path to the Azure Resource Manager parameters file or pass them as Key-Value Pairs.
  (See examples/Advanced.md)

• overrideParameters
  Specify the path to the Azure Resource Manager override parameters file or pass them as Key-Value Pairs.
  (See examples/Advanced.md)

Outputs

Every template output will be exported as output. For example the output is called containerName then it will be available with ${{ steps.STEP.outputs.containerName }}
For more Information see examples/Advanced.md.
Additionally are the following outputs available:

• deploymentName Specifies the complete deployment name which has been generated

Usage

- uses: whiteducksoftware/[email protected]
  with:
    creds: ${{ secrets.AZURE_CREDENTIALS }}
    resourceGroupName: <YourResourceGroup>
    templateLocation: <path/to/azuredeploy.json>
    deploymentName: <Deployment base name>

Example

on: [push]
name: AzureLoginSample

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - uses: whiteducksoftware/[email protected]
      with:
        creds: ${{ secrets.AZURE_CREDENTIALS }}
        resourceGroupName: <YourResourceGroup>
        templateLocation: <path/to/azuredeploy.json>
        parametersLocation: <path/to/parameters.json> OR  <KEY=VALUE>
        deploymentName: <Deployment base name>

For more advanced workflows see examples/Advanced.md.