Optimize change log and prepare for trusted publisher program (#15)

* refactored pipeline into template

* moved change logs to only be viewable on the GitHub pages.

* preparation for trusted publisher program

* added privacy notice

* added license notice

* added support link

* badge updates marketplace page

BuildPreparation.ps1

@@ -44,7 +44,7 @@ else {
 $output = [System.IO.Path]::GetFullPath($output)
 
 if ($prepareExtension) {
-    . ./tools/PrepareExtension.ps1 -sourcePath $sourcePath -outputDir $outputDir -generateChangeLog
+    . ./tools/PrepareExtension.ps1 -sourcePath $sourcePath -outputDir $outputDir
     Write-Output "Publish complete to $outputDir"
 }
 

azure-pipelines.yml

@@ -58,7 +58,7 @@ stages:
       parameters:
         CodeCoverage: 'true'
 
-    - pwsh: '$(Build.SourcesDirectory)/tools/PrepareExtension.ps1 -sourcePath $(sourcePath) -outputDir $(outputDir) -generateChangeLog'
+    - pwsh: '$(Build.SourcesDirectory)/tools/PrepareExtension.ps1 -sourcePath $(sourcePath) -outputDir $(outputDir)'
       displayName: 'Merge Extension Files for Build'
 
     - template: YamlTemplates/codeAnalysis.yml

docs/privacy.md

@@ -0,0 +1,17 @@
+---
+title: Privacy
+has_children: false
+nav_order: 4
+---
+
+# Privacy Notice
+
+The extension "Azure Policy and Governance Pipelines Tasks" provides the possibility to work with Azure DevOps pipelines to deploy Azure Policies from your repositories or artifact feeds. The extension is hosted by Azure DevOps itself.
+
+## Stored Data
+
+The data which is used by the extension is stored within the Azure DevOps agents or Azure DevOps itself. No data is stored on systems permanently which is owned by the creator of the application. No data which is processed through the extension (e.g. files from the repositories) is transferred or stored outside of Azure DevOps (Server as well as cloud hosted).
+
+## Contact
+
+If you have concerns please open an issue in the [respective repository](https://github.com/RazorSPoint/azure-devops-azure-policy-extension/issues).

src/eula.md

@@ -0,0 +1,3 @@
+# License
+
+The license is the MIT license and can be [viewed from the open source repository](https://github.com/RazorSPoint/azure-devops-azure-policy-extension/blob/master/LICENSE).

src/overview.md

@@ -20,3 +20,6 @@ This task is intended to make it easier for you to publish Azure Policies to you
 
 This task is intended to make it easier for you to publish Policy Sets (Initiatives) to your azure tenant. This tasks needs a Azure Resource Manager service connection with a properly configured service principal.
 
+## Change Logs
+
+Change logs can be found [on the documentation pages on GitHub](https://razorspoint.github.io/azure-devops-azure-policy-extension/CHANGELOG.html).

src/privacy.md

@@ -0,0 +1,3 @@
+# Privacy
+
+The privacy notes can viewed from the [provided GitHub pages](https://razorspoint.github.io/azure-devops-azure-policy-extension/privacy.html).

src/vss-extension.json

@@ -2,7 +2,7 @@
     "manifestVersion": 1,
     "id": "rp-build-release-azurepolicy",
     "name": "Azure Policy and Governance Pipelines Tasks",
-    "version": "2.0.3",
+    "version": "2.0.4",
     "publisher": "RazorSPoint",
     "targets": [{
         "id": "Microsoft.VisualStudio.Services"
@@ -24,9 +24,15 @@
     "content": {
         "details": {
             "path": "overview.md"
+        },
+        "license": {
+            "path": "eula.md"
+        },
+        "privacypolicy": {
+            "path":"privacy.md"
         }
     },
-    "links": {
+    "links": {        
         "getstarted": {
             "uri": "https://razorspoint.github.io/azure-devops-azure-policy-extension/"
         },
@@ -35,6 +41,9 @@
         },
         "issues": { 
             "uri": "https://github.com/RazorSPoint/azure-devops-azure-policy-extension/issues"
+        },
+        "support": {
+            "uri": "https://github.com/RazorSPoint/azure-devops-azure-policy-extension/issues"
         }
     },
     "repository": {
@@ -44,17 +53,27 @@
     "badges": [
         {
             "href": "https://dev.azure.com/razorspoint/RP_Build-Release-AzurePolicy/_build/latest?definitionId=19",
-            "uri": "https://dev.azure.com/razorspoint/RP_Build-Release-AzurePolicy/_apis/build/status/RazorSPoint.azure-devops-azure-policy-extension?branchName=master",
+            "uri": "https://dev.azure.com/razorspoint/RP_Build-Release-AzurePolicy/_apis/build/status/RazorSPoint.azure-devops-azure-policy-extension?branchName=master&stageName=Build&jobName=Build%20Extension&label=Build",
             "description": "Build"
         },
+        {
+            "href": "https://dev.azure.com/razorspoint/RP_Build-Release-AzurePolicy/_build/latest?definitionId=19",
+            "uri": "https://img.shields.io/azure-devops/tests/razorspoint/RP_Build-Release-AzurePolicy/19?label=unit%20tests",
+            "description": "Passed Unit Tests"
+        },
+        {
+            "href": "https://dev.azure.com/razorspoint/RP_Build-Release-AzurePolicy/_build/latest?definitionId=19",
+            "uri": "https://img.shields.io/azure-devops/coverage/razorspoint/RP_Build-Release-AzurePolicy/19?label=code%20coverage",
+            "description": "Code Coverage"
+        },
         {
             "href": "https://dev.azure.com/RazorSPoint/RP_Build-Release-AzurePolicy/_build/latest?definitionId=19&branchName=master",
-            "uri": "https://dev.azure.com/razorspoint/RP_Build-Release-AzurePolicy/_apis/build/status/RazorSPoint.azure-devops-azure-policy-extension?branchName=master&stageName=Build",
+            "uri": "https://dev.azure.com/razorspoint/RP_Build-Release-AzurePolicy/_apis/build/status/RazorSPoint.azure-devops-azure-policy-extension?branchName=master&stageName=Staging&jobName=Test%20Release&label=Test%20Release",
             "description": "Test Release"
         },
         {
             "href": "https://dev.azure.com/RazorSPoint/RP_Build-Release-AzurePolicy/_build/latest?definitionId=19&branchName=master",
-            "uri": "https://dev.azure.com/razorspoint/RP_Build-Release-AzurePolicy/_apis/build/status/RazorSPoint.azure-devops-azure-policy-extension?branchName=master&stageName=Staging",
+            "uri": "https://dev.azure.com/razorspoint/RP_Build-Release-AzurePolicy/_apis/build/status/RazorSPoint.azure-devops-azure-policy-extension?branchName=master&stageName=Production&jobName=Public%20Marketplace&label=Live%20Release",
             "description": "Live Release"
         }
     ],

tools/PrepareExtension.ps1

@@ -2,8 +2,7 @@
 [CmdletBinding()]
 param(
     [string]$sourcePath,
-    [string]$outputDir,
-    [switch]$generateChangeLog
+    [string]$outputDir
 )
 $ErrorActionPreference = "Stop"
 try {
@@ -26,14 +25,6 @@ try {
     Where-Object { $_.Name -in $excludesPaths } |
     Remove-Item -Force -Recurse
 
-    if ($generateChangeLog) {
-        Write-Output "generating extension readme with changelogs"
-        . ./tools/GenerateChangelog.ps1 `
-            -outputFilePath "$outputDir/overview.md" `
-            -readmeFilePath "./$outputDir/overview.md" `
-            -changelogFilePath "./docs/CHANGELOG.md"
-    }
-
     Write-Output "loading extension file from $outputDir\vss-extension.json"
     $extensionFileJson = Get-Content -Path "$outputDir\vss-extension.json" | Out-String | ConvertFrom-Json