From 236886a6bd3267e25b4e81ae448634880289c048 Mon Sep 17 00:00:00 2001
From: Clemens Wolff <clewolff@microsoft.com>
Date: Fri, 17 May 2019 02:10:12 -0400
Subject: [PATCH] Add documentation for pipeline variables

---
 azure-pipelines.yaml | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/azure-pipelines.yaml b/azure-pipelines.yaml
index 8cda230a..12da7d86 100644
--- a/azure-pipelines.yaml
+++ b/azure-pipelines.yaml
@@ -20,10 +20,29 @@ steps:
     testRunTitle: 'server.tests'
   displayName: 'Publish test results'
 
+# To publish docker images to a container registry, set the following pipeline variables:
+# - docker_password
+# - docker_username
+# - docker_registry (optional, set this to publish to a registry other than Docker Hub)
+#
 - script: DOCKER_PASSWORD="$(docker_password)" tools/cd.sh "azdo-$(Build.BuildId)"
   displayName: 'Push docker image'
   condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'), ne(variables['docker_password'], ''))
 
+# To automatically deploy to Azure, create a service principal and set the following pipeline variables:
+# - auth_username (app ID)
+# - auth_tenant (tenant ID
+# - auth_password (secret)
+#
+# Additionally, to configure the deployment, set the following pipeline variables:
+# - doccano_admin_username
+# - doccano_admin_password
+# - doccano_admin_contact_email
+# - doccano_app_name (globally unique name for the app)
+# - doccano_secret_key (pass-through secret for Django)
+# - doccano_resource_group (group for all resources, will be created if it doesn't yet exist)
+# - doccano_location (name of the Azure region to which to deploy all resources)
+#
 - script: |
     az login --service-principal --password "$(auth_password)" --tenant "$(auth_tenant)" --username "$(auth_username)"