adjusted the repo structure to include azure_pipeline task

Author: zaowang-ms

.github/workflows/azurePipelinesBuild.yml

@@ -0,0 +1,37 @@
+name: Build and Release for Azure Pipeline
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v2
+      with:
+        node-version: '14'
+
+    - name: Install dependencies and build
+      run: |
+        cd ./src
+        npm install
+        cd ..
+
+    - name: Install tfx-cli
+      run: |
+        npm install -g tfx-cli
+
+    - name: Create extension
+      run: |
+        tfx extension create --manifest-globs vss-extension.json
+
+    - name: Upload VSIX file
+      uses: actions/upload-artifact@v2
+      with:
+        name: VSIX file
+        path: ./*.vsix

.gitignore

@@ -0,0 +1,3 @@
+azure_pipeline/src/dist/
+azure_pipeline/src/node_modules/
+azure_pipeline/src/package-lock.json

azure_pipeline/development.md

@@ -0,0 +1,230 @@
+# Azure Pipeline task: NGINX for Azure Configuration Push (Development Guide)
+
+
+For the developing and publishing of the pipeline task, there are two ways to build and update the Azure DevOps pipeline tasks onto the market place if there are any new fixes or patches. 
+
+## Plan A. Manual Update
+
+### Step 1. Get vss-extension.json ready for packaging
+
+Vss-extension.json defines all information about your extension that will be displayed in the marketplace. 
+
+Please not that the name and id of this file is not finalized.
+
+```
+
+// vss-extension.json
+
+{
+    "manifestVersion": 1,
+    "id": "zao-nginx-config-push",
+    "name": "zao-nginx-config-push",
+    "version": "0.2.6",                                                    
+    "publisher": "zaotest",
+    "targets": [
+        {
+            "id": "Microsoft.VisualStudio.Services"
+        }
+    ],    
+    "description": "Zao's tool for uploading nginx config",
+    "categories": [
+        "Azure Pipelines"
+    ],
+    "icons": {
+        "default": "images/extension-icon.png"        
+    },
+    "files": [
+        {
+            "path": "src"
+        }
+    ],
+    "contributions": [
+        {
+            "id": "custom-build-release-task",
+            "type": "ms.vss-distributed-task.task",
+            "targets": [
+                "ms.vss-distributed-task.tasks"
+            ],
+            "properties": {
+                "name": "src"
+            }
+        }
+    ],
+    "galleryFlags": [
+        "Public"
+    ],
+    "public": false,
+    "tags":[
+        "Build task",
+        "Deploy task"
+    ]
+}
+
+```
+
+
+If this is the first time you are publishing the extension onto the marketplace, make sure the following keys have corresponded and correct value: id, name, publisher, description, icons. Otherwise, if this is just a normal update, all you need to do is just to make sure that the version number is updated to a greater one.
+
+For more details about vss-extension.json, please refer to ([Extension Manifest Reference - Azure DevOps | Microsoft Docs](https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest?view=azure-devops))
+
+### Step 2. Package the extension
+
+The whole project can be easily packaged by running the following single command:
+
+```
+tfx extension create --manifest-globs vss-extension.json
+```
+
+Now we will have a .vsix file generated automatically and ready for uploading to the marketplace portal.
+
+If this is the first time you are using this command, you may need to install tfx-cli by:
+
+```
+npm install -g tfx-cli
+```
+
+### Step 3. Upload the .vsix file onto the marketplace
+
+Sign in the Visual Studio Marketplace Publishing Portal. A normal update will be as easy as clicking the Update button of your extension and drag your .visx generated just now into it. 
+
+![Image](images/readme-marketplace.png)
+
+
+There will be a verification process running as soon as you uploaded the .visx file. Once the verification is completed, the Marketplace Publishing Portal will automatically update your extension to the newest version.
+
+However, if this is the first time you are publishing the pipeline extension, please refer to Step 5: Publish your extension [Add a build or release task in an extension - Azure DevOps | Microsoft Docs](https://docs.microsoft.com/en-us/azure/devops/extend/develop/add-build-task?view=azure-devops#create-your-publisher) to learn about how to create a new publisher account.
+
+
+## Plan B. Pipelined Update
+
+You can also set up an Azure pipeline to automate the updating and releasing process with the following template:
+
+```
+# build.yml
+# This is an example pipeline if we need a pipeline to update the task onto the market place
+# If we use manual update, this will not be needed.
+
+trigger: 
+- main
+
+pool:
+  vmImage: "ubuntu-latest"
+
+variables:
+  PublisherID: 
+  ExtensionID: 
+  ExtensionName: 
+  ExtensionVersion: 
+  ArtifactStagingDirectory: './artifact'
+  ArtifactName: 'extension_artifact'
+
+
+
+stages:
+  - stage: Package_extension_and_publish_build_artifacts
+    jobs:
+      - job:
+        steps:
+          - task: TfxInstaller@3
+            inputs:
+              version: "v0.7.x"
+          - task: Npm@1
+            inputs:
+              command: 'install'
+              workingDir: './src' # Update to the name of the directory of your task
+          - task: Bash@3
+            displayName: Compile Javascript
+            inputs:
+              targetType: "inline"
+              script: |
+                cd src # Update to the name of the directory of your task
+                tsc
+          - task: QueryAzureDevOpsExtensionVersion@3
+            inputs:
+              connectTo: 'VsTeam'
+              connectedServiceName: 'release-test-connection' # Change to whatever you named the service connection
+              publisherId: '$(PublisherID)'
+              extensionId: '$(ExtensionID)'
+              versionAction: 'Patch'
+              outputVariable: 'Task.Extension.Version'
+          - task: PackageAzureDevOpsExtension@3
+            inputs:
+              rootFolder: '$(System.DefaultWorkingDirectory)'
+              publisherId: '$(PublisherID)'
+              extensionId: '$(ExtensionID)'
+              extensionName: '$(ExtensionName)'
+              extensionVersion: '$(ExtensionVersion)'
+              updateTasksVersion: true
+              updateTasksVersionType: 'patch'
+              extensionVisibility: 'private' # Change to public if you're publishing to the marketplace
+              extensionPricing: 'free'
+          - task: CopyFiles@2
+            displayName: "Copy Files to: $(ArtifactStagingDirectory)"
+            inputs:
+              Contents: "**/*.vsix"
+              TargetFolder: "$(ArtifactStagingDirectory)"
+          - task: PublishBuildArtifacts@1
+            inputs:
+              PathtoPublish: '$(ArtifactStagingDirectory)'
+              ArtifactName: '$(ArtifactName)'
+              publishLocation: 'Container'
+  - stage: Download_build_artifacts_and_publish_the_extension
+    jobs:
+      - job:
+        steps:
+          - task: TfxInstaller@3
+            inputs:
+              version: "v0.7.x"
+          - task: DownloadBuildArtifacts@0
+            inputs:
+              buildType: "current"
+              downloadType: "single"
+              artifactName: "$(ArtifactName)"
+              downloadPath: "$(System.DefaultWorkingDirectory)"
+          - task: PublishAzureDevOpsExtension@3
+            inputs:
+              connectTo: 'VsTeam'
+              connectedServiceName: 'release-test-connection' # Change to whatever you named the service connection
+              fileType: 'vsix'
+              vsixFile: '$(PublisherID).$(ExtensionName)/$(PublisherID)..vsix'
+              publisherId: '$(PublisherID)'
+              extensionId: '$(ExtensionID)'
+              extensionName: '$(ExtensionName)'
+              updateTasksVersion: false
+              extensionVisibility: 'private' # Change to public if you're publishing to the marketplace
+              extensionPricing: 'free'
+
+```
+
+
+This will allow the pipeline automatically start building the package and update the extension onto the marketplace.
+
+However, in order to enable this pipeline, you may need to:
+
+### Step 1. Create an organization as well as a project on Azure DevOps. 
+
+See [Create a project - Azure DevOps | Microsoft Docs](https://docs.microsoft.com/en-us/azure/devops/organizations/projects/create-project?tabs=browser&view=azure-devops).
+
+### Step 2. Install Azure DevOps Extension Task to your Azure DevOps organization. 
+
+See [Azure DevOps Extension Tasks - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=ms-devlabs.vsts-developer-tools-build-tasks&targetId=85fb3d5a-9f21-420f-8de3-fc80bf29054b&utm_source=vstsproduct&utm_medium=ExtHubManageList).
+
+### Step 3. Generate a personal access token on Azure DevOps. 
+
+This token will be used later when we create a service connection. Configure the authorization scope for the token as follows or refer to [Azure DevOps Extension Tasks - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=ms-devlabs.vsts-developer-tools-build-tasks&targetId=85fb3d5a-9f21-420f-8de3-fc80bf29054b&utm_source=vstsproduct&utm_medium=ExtHubManageList).
+
+![Image](images/readme-personal-access-token.png)
+
+![Image](images/readme-token-scopes.png)
+
+
+### Step 4. Create a service connection in order to authorize the pipeline’s agent for accessing Visual Studio MarketPlace.
+
+On how to create a service connection, see [Service connections in Azure Pipelines - Azure Pipelines | Microsoft Docs](https://docs.microsoft.com/en-us/azure/devops/pipelines/library/service-endpoints?tabs=yaml&view=azure-devops). Note that you may need to select Visual Studio Marketplace for the service connection type.
+
+![Image](images/readme-service-connections.png)
+
+
+### Step 5. Compose the .yml file.
+
+After all the previous steps, you are now able to create a build and release pipeline using the template we mentioned at the beginning. This task will be automatically packaged and updated to the marketplace once the pipeline is triggered.

azure_pipeline/example.yml

@@ -0,0 +1,16 @@
+trigger:
+- main
+
+pool:
+  vmImage: ubuntu-latest
+
+steps:  
+- task: nginx-config-push@0
+  inputs:
+    serviceConnectionName: '(sercive-connection-name)'
+    resourceGroupName: '(resource-group-name)'
+    subscriptionId: '(subscription-id)'
+    deploymentName: '(deployment-name)'
+    sourceConfigFolderPath: '(config-folder-file-path)'
+    targetConfigFolderPath: '/etc/nginx/'
+

azure_pipeline/images/extension-icon.png

@@ -0,0 +1,95 @@
+# Azure Pipeline task: NGINX for Azure Configuration Push
+
+## Overview
+
+This is a customed Azure pipeline task that automates the process of synchronizing NGINX configuration files. With this pipeline, the configuration files that are stored and managed in Azure DevOps or GitHub repositories can now be automatically packaged and uploaded to NGINX for Azure deployments.
+
+When creating and updatding the configuration of a NGINX for Azure deployment, an automated pipeline task would be very helpful. There are three main advantages of a pipeline task compared to a manual updation:
+
+##### 1. Automation.
+
+A pipeline task can be triggered immediately if designated NGINX coniguration files have changes. This would increase effectiveness when there are frequent modifications and updates.
+
+##### 2. Version control.
+
+NGINX configuration files could be stored in GitHub or Azure DevOps repositories. In this way, all configure changes would be able to be traced and rolled back if there is a mistake.
+
+##### 3. Security.
+Pipelines are running in secured and reliable agents, where data is transmitted within Azure services, hence reduced unnecessary data distribution and delivery.
+
+NGINX for Azure currently supports both <strong>GitHub Action </strong>pipeline and  <strong>Azure DevOps</strong> pipeline task. While there are some authentication and repository supporting difference, the purpose and functionality of the two pipelines have no essential distinction. For details on GitHub Action pipeline, please check out NGINX for Azure Deployment Action for more details. For Azure DevOps pipeline task, please follow the instructions below.
+
+### Pipeline Task Set-up Guideline
+
+Basically, all that the pipeline task needed is a .yml task written as follows,
+
+```
+# example.yml
+
+trigger:
+- main
+
+pool:
+  vmImage: ubuntu-latest
+
+steps:  
+- task: nginx-config-push@0
+  inputs:
+    serviceConnectionName: '(sercive-connection-name)'
+    resourceGroupName: '(resource-group-name)'
+    subscriptionId: '(subscription-id)'
+    deploymentName: '(deployment-name)'
+    sourceConfigFolderPath: '(config-folder-file-path)'
+    targetConfigFolderPath: '/etc/nginx/'
+
+```
+ 
+What is needed right now is to get values of the needed variables with following steps:
+
+
+##### 1. Get your NGINX configuration file ready in the repository.
+
+Upload your NGINX configuration files onto any folder of your Azure DevOps repository. Then update the ‘sourceConfigFolderPath’ to the path of the configuration folder in your repository. Note that the name of the main file of the NGINX configuration folder should be “nginx.conf”, and the ‘targetConfigFolderPath’ would usually be /etc/nginx/.
+
+![Image](images/readme-guidline-01.png)
+
+ 
+##### 2. Make sure your NGINX for Azure deployment is working properly.
+
+Deploy a NGINX for Azure resource. See Deploy NGINX for Azure | NGINX for Azure Docs. Once your deployment is ready, you will be able to fill in the “resourceGroupName”, “subscriptionId” and the “deploymentName” variable from the portal overview board.
+
+![Image](images/readme-guidline-02.png)
+ 
+
+
+##### 3. Create a service connetion and grant permission for the pipeline.
+
+This part would require a little bit more work to set up.
+A service connection gives you access to resources in your Azure subscription from your Azure DevOps project.
+1.	In Azure DevOps, go to the project that contains your target pipeline. In the lower-left corner, select Project settings.
+2.	Under Pipelines, select Service connections. In the upper-right corner, select New service connection.
+3.	In New service connection, select Azure Resource Manager.
+ 
+![Image](images/readme-guidline-03.png)
+
+4.	In the Authentication method dialog, select Service principal (automatic) to create a new service principal or select Service principal (manual) to use an existing service principal.
+5.	Enter your subscription and resource and a name for your service connection.
+
+Also, you may need to assign a proper role assignment to the service connection so that our pipeline can access NGINX for azure deployments. You can add Contributor as your role assignment to this service connection.
+
+![Image](images/readme-guidline-04.png)
+ 
+
+Go back to the Azure DevOps project settings and click into the “service connection” tab. Remember the name displayed in the service connections list. This will be the value of ‘serciveConnectionName’ in the .yml file.
+
+![Image](images/readme-guidline-05.png)
+ 
+
+##### 4. Install the pipeline task and fill all the needed variables into the .yml file on Azure DevOps.
+
+Go to marketplace and search our pipeline task. Once you have the extension installed on your Azure DevOps organization, you will be able to create a pipeline task with the stated .yml file template and use our customized task conveniently. You can also use text editor of the pipeline to utilize a simple UI of this pipeline task.
+
+<br />
+<br />
+
+That's it! Once you have all the above settings done and a pipeline created on the Azure DevOps, your NGINX configuration will be automatically updated to your designated NGINX for Azure deployment resource once you have any changes to the files in the repository and the pipeline is triggered.