Merge pull request #37 from nginxinc/ps-dev-readme

Update Actions usage instructions

Author: puneetsarna

.github/workflows/github-action-test-nginxaas-deploy.yml

@@ -36,7 +36,7 @@ jobs:
           sed -i 's/000000/'"$GITHUB_RUN_ID"'/g' github-action/test/configs/single/nginx.conf
           cat github-action/test/configs/single/nginx.conf
       - name: "Sync NGINX configuration to NGINXaaS for Azure - single file"
-        uses: nginxinc/nginx-for-azure-deploy-action@v0.3.1
+        uses: nginxinc/nginx-for-azure-deploy-action/github-action@v0.4.0
         with:
           subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
           resource-group-name: $TEST_RESOURCE_GROUP_NAME
@@ -56,7 +56,7 @@ jobs:
           sed -i 's/000000/'"$GITHUB_RUN_ID"'/g' github-action/test/configs/multi/conf.d/proxy.conf
           cat github-action/test/configs/multi/conf.d/proxy.conf
       - name: "Sync NGINX configuration and certificate to NGINXaaS for Azure - multi file"
-        uses: nginxinc/nginx-for-azure-deploy-action@v0.3.1
+        uses: nginxinc/nginx-for-azure-deploy-action/github-action@v0.4.0
         with:
           subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
           resource-group-name: $TEST_RESOURCE_GROUP_NAME

github-action/README.md

@@ -34,14 +34,15 @@ jobs:
         creds: ${{ secrets.AZURE_CREDENTIALS }}
 
     - name: 'Sync the NGINX configuration from the GitHub repository to the NGINXaaS for Azure deployment'
-      uses: nginxinc/nginx-for-azure-deploy-action@v0.3.1
+      uses: nginxinc/nginx-for-azure-deploy-action/github-action@v0.4.0
       with:
         subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
         resource-group-name: ${{ secrets.AZURE_RESOURCE_GROUP_NAME }}
         nginx-deployment-name: ${{ secrets.NGINX_DEPLOYMENT_NAME }}
         nginx-config-directory-path: config/
         nginx-root-config-file: nginx.conf
         transformed-nginx-config-directory-path: /etc/nginx/
+        debug: false
 ```
 
 ### Sample workflow that authenticates with Azure using OIDC
@@ -76,14 +77,15 @@ jobs:
         subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
 
     - name: 'Sync the NGINX configuration from the GitHub repository to the NGINXaaS for Azure deployment'
-      uses: nginxinc/nginx-for-azure-deploy-action@v0.3.1
+      uses: nginxinc/nginx-for-azure-deploy-action/github-action@v0.4.0
       with:
         subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
         resource-group-name: ${{ secrets.AZURE_RESOURCE_GROUP_NAME }}
         nginx-deployment-name: ${{ secrets.NGINX_DEPLOYMENT_NAME }}
         nginx-config-directory-path: config/
         nginx-root-config-file: nginx.conf
         transformed-nginx-config-directory-path: /etc/nginx/
+        debug: false
 ```
 
 > **Note:**
@@ -104,13 +106,14 @@ To use this action to sync the configuration files from this example, the direct
 
 ```yaml
     - name: 'Sync the NGINX configuration from the GitHub repository to the NGINXaaS for Azure deployment'
-      uses: nginxinc/nginx-for-azure-deploy-action@v0.3.1
+      uses: nginxinc/nginx-for-azure-deploy-action/github-action@v0.4.0
       with:
         subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
         resource-group-name: ${{ secrets.AZURE_RESOURCE_GROUP_NAME }}
         nginx-deployment-name: ${{ secrets.NGINX_DEPLOYMENT_NAME }}
         nginx-config-directory-path: config/
         nginx-root-config-file: nginx.conf
+        debug: false
 ```
 
 By default, the action uses a file's relative path to `nginx-config-directory-path` in the repository as the file path in the NGINXaaS for Azure deployment.
@@ -136,14 +139,15 @@ The action supports an optional input `transformed-nginx-config-directory-path`
 
 ```yaml
     - name: 'Sync the NGINX configuration from the Git repository to the NGINXaaS for Azure deployment'
-      uses: nginxinc/nginx-for-azure-deploy-action@v0.3.1
+      uses: nginxinc/nginx-for-azure-deploy-action/github-action@v0.4.0
       with:
         subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
         resource-group-name: ${{ secrets.AZURE_RESOURCE_GROUP_NAME }}
         nginx-deployment-name: ${{ secrets.NGINX_DEPLOYMENT_NAME }}
         nginx-config-directory-path: config/
         nginx-root-config-file: nginx.conf
         transformed-nginx-config-directory-path: /etc/nginx/
+        debug: false
 ```
 The transformed paths of the two configuration files in the NGINXaaS for Azure deployment are summarized in the following table
 
@@ -168,20 +172,21 @@ See the example below
 
 ```yaml
 - name: "Sync NGINX certificates to NGINXaaS for Azure"
-        uses: nginxinc/nginx-for-azure-deploy-action@v0.3.1
+        uses: nginxinc/nginx-for-azure-deploy-action/github-action@v0.4.0
         with:
           subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
           resource-group-name: ${{ secrets.AZURE_RESOURCE_GROUP_NAME }}
           nginx-deployment-name: ${{ secrets.NGINX_DEPLOYMENT_NAME }}
           nginx-deployment-location: ${{ secrets.NGINX_DEPLOYMENT_LOCATION }}
           nginx-certificates: '[{"certificateName": "$NGINX_CERT_NAME", "keyvaultSecret": "https://$NGINX_VAULT_NAME.vault.azure.net/secrets/$NGINX_CERT_NAME", "certificateVirtualPath": "/etc/nginx/ssl/my-cert.crt", "keyVirtualPath": "/etc/nginx/ssl/my-cert.key"  } ]'
+          debug: false
 ```
 
 ## Handling NGINX configuration and certificates
 
 ```yaml
  - name: "Sync NGINX configuration- multi file and certificate to NGINXaaS for Azure"
-        uses: nginxinc/nginx-for-azure-deploy-action@v0.3.1
+        uses: nginxinc/nginx-for-azure-deploy-action/github-action@v0.4.0
         with:
           subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
           resource-group-name: ${{ secrets.AZURE_RESOURCE_GROUP_NAME }}
@@ -191,4 +196,5 @@ See the example below
           nginx-root-config-file: nginx.conf
           transformed-nginx-config-directory-path: /etc/nginx/
           nginx-certificates: '[{"certificateName": "$NGINX_CERT_NAME", "keyvaultSecret": "https://$NGINX_VAULT_NAME.vault.azure.net/secrets/$NGINX_CERT_NAME", "certificateVirtualPath": "/etc/nginx/ssl/my-cert.crt", "keyVirtualPath": "/etc/nginx/ssl/my-cert.key"  } ]'
+          debug: false
 ```