From c29360959cb848a2c7e1001e233bc5e79b526827 Mon Sep 17 00:00:00 2001 From: Dhruv Chand Date: Tue, 11 Jul 2023 10:52:45 -0700 Subject: [PATCH 1/2] Adds usage info to each task --- Tasks/ChocoTask/choco.ps1 | 3 ++- Tasks/ChocoTask/task.yaml | 12 ++++++++++++ Tasks/install-vs-extension/task.yaml | 11 ++++++++++- Tasks/powershell/task.yaml | 8 ++++++++ 4 files changed, 32 insertions(+), 2 deletions(-) diff --git a/Tasks/ChocoTask/choco.ps1 b/Tasks/ChocoTask/choco.ps1 index 9919f2e..e22ba61 100644 --- a/Tasks/ChocoTask/choco.ps1 +++ b/Tasks/ChocoTask/choco.ps1 @@ -116,6 +116,7 @@ Write-Host 'Ensuring latest Chocolatey version is installed.' Ensure-Chocolatey -ChocoExePath "$choco" Write-Host "Preparing to install Chocolatey packages: $Packages." -Install-Packages -ChocoExePath "$choco" -Packages $Packages -PackageVersions $PackageVersions -AdditionalOptions $AdditionalOptions +Install-Packages -ChocoExePath "$choco" -Packages $Packages - + $PackageVersions -AdditionalOptions $AdditionalOptions Write-Host "`nThe artifact was applied successfully.`n" diff --git a/Tasks/ChocoTask/task.yaml b/Tasks/ChocoTask/task.yaml index 4b475af..16b331c 100644 --- a/Tasks/ChocoTask/task.yaml +++ b/Tasks/ChocoTask/task.yaml @@ -1,3 +1,15 @@ +# This task installs choco package files +# +# USAGE +# +# - task: choco +# inputs: +# packages: "vscode, azure-cli" +# Versions: "{ 'vscode'='1.80.0'; 'azure-cli'='2.50.0' }" +# additionalOptions: "--verbose --ignore-dependencies" +# + + name: choco command: "./choco.ps1 -Packages {{packages}} -Versions {{Versions}}" inputs: diff --git a/Tasks/install-vs-extension/task.yaml b/Tasks/install-vs-extension/task.yaml index 8a32fbf..0df9f91 100644 --- a/Tasks/install-vs-extension/task.yaml +++ b/Tasks/install-vs-extension/task.yaml @@ -1,4 +1,13 @@ -# This is a Visual Studio extension installation task for Dev Box. +# This is a Visual Studio extension installation task for Dev Box. +# It accepts a Markplace Item Name (as used in the URI of a given Visual Studio Extension Maketplace entry) +# +# USAGE +# +# - task: install-vs-extension +# inputs: +# marketplaceItemName: "GitHub.copilotvs" +# + name: install-vs-extension description: Installs a Visual Studio extension diff --git a/Tasks/powershell/task.yaml b/Tasks/powershell/task.yaml index 69f4c6c..c602650 100644 --- a/Tasks/powershell/task.yaml +++ b/Tasks/powershell/task.yaml @@ -1,4 +1,12 @@ # This is a simple powershell command execution task for Dev Box. +# +# USAGE +# +# - task: powershell +# inputs: +# command: "Get-Date" +# workingDirectory: "." +# name: powershell description: Execute a powershell command From 6d39a0e921beff9924e265b5f16f32efb64413c9 Mon Sep 17 00:00:00 2001 From: Dhruv Chand Date: Tue, 11 Jul 2023 10:53:56 -0700 Subject: [PATCH 2/2] remove stray new line --- Tasks/ChocoTask/choco.ps1 | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/Tasks/ChocoTask/choco.ps1 b/Tasks/ChocoTask/choco.ps1 index e22ba61..cfdf2ec 100644 --- a/Tasks/ChocoTask/choco.ps1 +++ b/Tasks/ChocoTask/choco.ps1 @@ -116,7 +116,6 @@ Write-Host 'Ensuring latest Chocolatey version is installed.' Ensure-Chocolatey -ChocoExePath "$choco" Write-Host "Preparing to install Chocolatey packages: $Packages." -Install-Packages -ChocoExePath "$choco" -Packages $Packages - - $PackageVersions -AdditionalOptions $AdditionalOptions +Install-Packages -ChocoExePath "$choco" -Packages $Packages -$PackageVersions -AdditionalOptions $AdditionalOptions Write-Host "`nThe artifact was applied successfully.`n"