Fix WinGet releasing process (#144)

This release marks the adoption of .NET Source Generators as a core part of the TfsCmdlets development process.

Although it is entirely opaque (and mostly irrelevant) to the end-user, we expect that they will allow us to have shorter and more stable releases in the future.

Now, back to the release notes :-) We have new cmdlets, a bunch of improvements and bug fixes, and a few minor _breaking changes_.

## New cmdlets

* **Extension Management**
  * `Enable-TfsExtension`
  * `Disable-TfsExtension`
  * `Get-TfsExtension`
  * `Install-TfsExtension`
  * `Uninstall-TfsExtension`
* **Git**
  * `Get-TfsGitItem`
* **Identities, Users and Groups**
  * `Get-TfsGroup`
  * `New-TfsGroup`
  * `Remove-TfsGroup`
  * `Get-TfsUser`
* **Pipeline**
  * `Get-TfsBuildDefinition`
  * `Enable-TfsBuildDefinition`
  * `Disable-TfsBuildDefinition`
  * `Suspend-TfsBuildDefinition`
  * `Resume-TfsBuildDefinition`
* **Organization**
  * `Connect-TfsOrganization`
  * `Disconnect-TfsOrganization`  
  * `Get-TfsOrganization`
* **Team project**
  * `Import-TfsTeamProjectAvatar`
  * `Export-TfsTeamProjectAvatar`
  * `Remove-TfsTeamProjectAvatar`
* **Work Items**
  * `Enable-TfsWorkItemTag`
  * `Disable-TfsWorkItemTag`
  * `Undo-TfsWorkItemRemoval`

## Improvements
  
* `Import-TfsWorkItemType` and `Export-TfsWorkItemType` now support importing from / exporting to files (and not only to the console)
* Add -NoProfile to Enter-TfsShell ([#145](#145))
* Most Get-* cmdlets now support retrieving multiple items at once by supplying a list of IDs/names/etc. (e.g. `Get-TfsTeamProject Proj1, Proj2`). That, by consequence, fixes issue [#155](#155)
* Remove trailing slash from org name in prompt ([#148](#148))
* Filter team project by process template ([#104](#104))
* `Get-TfsWorkItem` now makes batch API calls to improve performance. The gains are expressive - an order of magnitude in many cases.
* `Invoke-TfsRestApi` can now save the response to a file, via its `-Destination` argument. Besides, binary content (such as 'application/octet-stream') is returned as a byte array (instead of a string) when outputting the results to the console.
* `Set-TfsTeam` has new arguments `-OverwriteAreaPaths` and `-OverwriteIterationPaths` to control its behavior when setting default areas and sprint iterations, respectively. Additionally, both -AreaPaths and -IterationPaths now support wildcards to simplify the addition of multiple items at once.

## Fixes

* Fixes a bug in `Set-TfsTeam` where the -IterationPaths argument was ignored, and the sprint iterations were not set. Now sprint iterations are set as expected.
* Get-TfsGroupMember does not work with PS Core and Azure DevOps Services ([#149](#149))
* New-TfsWorkItem fails when specifying area and iteration without prefixing team project ([#147](#147))
* Fixes a bug in `Get-TfsWorkItem` where when using the `-Description` an error is thrown.
* And many other under-the-hood fixes caught during the development of this release

## BREAKING CHANGES

### Removed cmdlets

Some legacy cmdlets (primarily those that rely on the old TFS Client Object Model) have been temporarily removed. They _may_ return in a future release when we determine the best course of action to support legacy cmdlets moving forward.

In the meantime, please consider using a previous release if you need them.

The removed cmdlets are:

* **Administration** cmdlets
  * `Start-TfsIdentitySync`
* **Configuration Server** cmdlets
  * `Connect-TfsConfigurationServer`
  * `Disconnect-TfsConfigurationServer`
  * `Get-TfsConfigurationServer`
  * `Get-TfsRegisteredConfigurationServer`
* **Global List** cmdlets
  * `Export-TfsGlobalList`
  * `Get-TfsGlobalList`
  * `Import-TfsGlobalList`
  * `New-TfsGlobalList`
  * `Remove-TfsGlobalList`
  * `Rename-TfsGlobalList`
  * `Set-TfsGlobalList`
* **Pipeline** cmdlets
  * `Start-TfsXamlBuild`
* **Team Project Collection** cmdlets
  * `Dismount-TfsTeamProjectCollection`
  * `Mount-TfsTeamProjectCollection`
  * `Start-TfsTeamProjectCollection`
  * `Stop-TfsTeamProjectCollection`
* **Work Item** cmdlets
  * `Copy-TfsWorkItem`

### Get-TfsTeamProject -IncludeDetails

Every team project returned by `Get-TfsTeamProject` used to make a second API call to retrieve the details of the team project, such as its process template. That additional roundtrip meant that the command would take longer to complete. However, those details are rarely needed in most scenarios.

Therefore, to improve performance for the most common situations, `Get-TfsTeamProject` no longer includes project details by default.

When needed - the most common scenario is to get the process template name of a given project - you must include the `-IncludeDetails` switch.

### Get-TfsWorkItem and max work items per call

The change in `Get-TfsWorkItem` to use batch calls greatly improved performance, but the downside is that now you're limited to up to 200 work items returned in a single call. That limit is imposed by the backend REST API and can't be circumvented.

We're exploring alternatives for those scenarios when one needs to retrieve more than 200 work items (e.g., when doing an export).

+semver: minor

Author: igoravl

.editorconfig

@@ -0,0 +1,6 @@
+root = true
+
+[*.cs]
+
+dotnet_diagnostic.IDE0056.severity = none
+dotnet_diagnostic.IDE0057.severity = none

.github/workflows/main.yml

@@ -16,6 +16,9 @@ jobs:
   Build:
 
     runs-on: windows-latest
+    env:
+      TFSCMDLETS_ACCESS_TOKEN: ${{ secrets.TFSCMDLETS_TOKEN }}
+      TFSCMDLETS_COLLECTION_URL: 'https://dev.azure.com/tfscmdlets'
     steps:
       - name: Checkout code
         uses: actions/checkout@v2

.gitignore

@@ -217,4 +217,4 @@ CSharp/.idea/**
 
 # Miscellaneous files
 
-.testtemplate.cs
+CSharp/*/Generated/**

.vscode/tasks.json

@@ -9,7 +9,6 @@
                 "kind": "build",
                 "isDefault": true
             },
-            "problemMatcher": "$msCompile",
             "presentation": {
                 "echo": true,
                 "reveal": "always",
@@ -27,7 +26,11 @@
                 "-Configuration",
                 "Debug",
                 "-Targets",
-                "Build"
+                "Build",
+                "-SkipTests"
+            ],
+            "problemMatcher": [
+                "$msCompile"
             ]
         },
         {
@@ -48,7 +51,11 @@
                 "-File",
                 "${workspaceRoot}/build.ps1",
                 "-Targets",
-                "Rebuild"
+                "Rebuild",
+                "-SkipTests"
+            ],
+            "problemMatcher": [
+                "$msCompile"
             ]
         },
         {

Build.ps1

@@ -15,8 +15,7 @@ Param
     [switch] $Incremental
 )
 
-Function Install-Dependencies
-{
+Function Install-Dependencies {
     $NugetPackages = @('GitVersion.CommandLine')
     $PsModules = @('psake', 'PsScriptAnalyzer', 'VSSetup', 'powershell-yaml', 'ps1xmlgen', 'PlatyPS')
 
@@ -28,90 +27,74 @@ Function Install-Dependencies
 
     Write-Verbose "Restoring NuGet package(s) ($($NugetPackages -join ', '))"
 
-    foreach($pkg in $NugetPackages)
-    {
+    foreach ($pkg in $NugetPackages) {
         Install-NugetPackage $pkg
     }
 
     Write-Verbose "Restoring PowerShell module(s) ($($PsModules -join ', '))"
 
-    foreach($mod in $PsModules)
-    {
+    foreach ($mod in $PsModules) {
         Install-PsModule $mod
     }
 }
 
-Function Install-Nuget
-{
+Function Install-Nuget {
     Write-Verbose "Restoring Nuget client"
 
     $BuildToolsDir = Join-Path $RootProjectDir 'BuildTools'
     $script:NugetExePath = Join-Path $BuildToolsDir 'nuget.exe'
 
-    if (-not (Test-Path $PackagesDir -PathType Container))
-    {
+    if (-not (Test-Path $PackagesDir -PathType Container)) {
         mkdir $PackagesDir -Force | Write-Verbose
     }
 
-    if (-not (Test-Path $BuildToolsDir -PathType Container))
-    {
+    if (-not (Test-Path $BuildToolsDir -PathType Container)) {
         mkdir $BuildToolsDir -Force | Write-Verbose
     }
 
-    if (-not (Test-Path $NugetExePath -PathType Leaf))
-    {
+    if (-not (Test-Path $NugetExePath -PathType Leaf)) {
         Write-Verbose "Nuget.exe not found. Downloading from https://dist.nuget.org"
         Invoke-WebRequest -Uri https://dist.nuget.org/win-x86-commandline/latest/nuget.exe -OutFile $NugetExePath | Write-Verbose
     }
-    else
-    {
+    else {
         Write-Verbose "NuGet client found; Skipping..."    
     }
 
     Write-Verbose "NugetExePath: $NugetExePath"
 }
 
-Function Install-NugetPackage($Package)
-{
+Function Install-NugetPackage($Package) {
     Write-Verbose "Restoring NuGet package $Package"
 
     $modulePath = Join-Path $RootProjectDir "packages/$Package"
 
-    if (-not (Test-Path "$modulePath/*" -PathType Leaf))
-    {
+    if (-not (Test-Path "$modulePath/*" -PathType Leaf)) {
         Write-Verbose "Package not found. Downloading from Nuget.org"
         & $NugetExePath Install $Package -ExcludeVersion -OutputDirectory packages *>&1 | Write-Verbose
     }
-    else
-    {
+    else {
         Write-Verbose "NuGet package $Package found; Skipping..."    
     }
 }
 
-Function Install-PsModule($Module)
-{
+Function Install-PsModule($Module) {
     Write-Verbose "Restoring module $Module"
 
-    if (-not (Get-Module $Module -ListAvailable))
-    {
-        if (-not (Get-PackageProvider -Name Nuget -ListAvailable -ErrorAction SilentlyContinue))
-        {
+    if (-not (Get-Module $Module -ListAvailable)) {
+        if (-not (Get-PackageProvider -Name Nuget -ListAvailable -ErrorAction SilentlyContinue)) {
             Write-Verbose "Installing required Nuget package provider in order to install modules from PowerShell Gallery"
             Install-PackageProvider Nuget -Force -Scope CurrentUser | Write-Verbose
         }
 
         Install-Module $Module -Scope CurrentUser -Force | Write-Verbose
     }
-    else
-    {
+    else {
         Write-Verbose "PowerShell module $Module found; Skipping..."    
     }
 }
 
-try
-{
-    if (-not $RootProjectDir)
-    {
+try {
+    if (-not $RootProjectDir) {
         $RootProjectDir = $PSScriptRoot
     }
 
@@ -143,13 +126,11 @@ try
 
     $isCI = $false
 
-    if ($env:BUILD_BUILDURI)
-    {
+    if ($env:BUILD_BUILDURI) {
         Write-Output "##vso[build.updatebuildnumber]$BuildName"
         $isCI = $true
     }
-    elseif ($env:GITHUB_ACTIONS)
-    {
+    elseif ($env:GITHUB_ACTIONS) {
         Write-Output "::set-output name=BUILD_NAME::$BuildName"
         $isCI = $true
     }
@@ -162,38 +143,39 @@ try
     Write-Verbose "=== BEGIN PSAKE ==="
     Write-Verbose "Invoking Psake script $psakeScript"
 
-    Invoke-Psake -Nologo -BuildFile $psakeScript -TaskList $Targets -Verbose:$IsVerbose `
-      -Parameters @{
-        RootProjectDir = $RootProjectDir
-        Configuration = $Configuration
-        ModuleName = $ModuleName
-        ModuleAuthor = $ModuleAuthor
+    Invoke-Psake -Nologo -BuildFile $psakeScript -TaskList $Targets -Verbose:$IsVerbose -ErrorAction SilentlyContinue `
+        -Parameters @{
+        RootProjectDir    = $RootProjectDir
+        Configuration     = $Configuration
+        ModuleName        = $ModuleName
+        ModuleAuthor      = $ModuleAuthor
         ModuleDescription = $ModuleDescription
-        BuildName = $BuildName
-        BuildNumber = $ProjectBuildNumber
-        VersionMetadata = $VersionMetadata 
-        SkipTests = $SkipTests.IsPresent
-        Incremental = $Incremental.IsPresent
-        IsCI = $isCI
+        BuildName         = $BuildName
+        BuildNumber       = $ProjectBuildNumber
+        VersionMetadata   = $VersionMetadata 
+        SkipTests         = $SkipTests.IsPresent
+        Incremental       = $Incremental.IsPresent
+        IsCI              = $isCI
     }
 
     Write-Verbose "=== END PSAKE ==="
-
 }
-finally
-{
+finally {
     Pop-Location
 }
 
-if (-not $psake.build_success)
-{
-    $msbuildLog = (Join-Path $RootProjectDir 'out/MSBuild.log')
-
-    if (Test-Path $msbuildLog)
+if (-not $psake.build_success) {
+    foreach($logFile in (Get-ChildItem (Join-Path $RootProjectDir 'out/*.log')))
     {
-        Write-Host '========== MSBUILD LOG ===========' -ForegroundColor Red
-        Get-Content $msbuildLog | Write-Host -ForegroundColor Red
-        Write-Host '======== END MSBUILD LOG =========' -ForegroundColor Red
+        Write-Host -ForegroundColor Red @"
+
+========== MSBUILD LOG ===========
+
+$(Get-Content $logFile -Raw)
+
+======== END MSBUILD LOG =========
+
+"@
     }
 
     throw "Build failed. See log above for details."

CSharp/TfsCmdlets.Common/Attributes.cs

@@ -0,0 +1,42 @@
+namespace TfsCmdlets
+{
+    [AttributeUsage(System.AttributeTargets.Class, Inherited = true, AllowMultiple = false)]
+    public class CmdletControllerAttribute: ExportAttribute
+    {
+        public Type DataType { get; }
+
+        public string CustomCmdletName { get; set; }
+
+        public string[] CustomVerbs { get; set; }
+
+        public string[] CustomNouns { get; set; }
+
+        public Type CustomBaseClass { get; set; }
+
+        public CmdletControllerAttribute() : base(typeof(IController))
+        {
+        }
+
+        public CmdletControllerAttribute(Type dataType) : base(typeof(IController))
+        {
+            DataType = dataType;
+        }
+    }
+
+    // [AttributeUsage(System.AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
+    // public sealed class DesktopOnlyAttribute : Attribute
+    // {
+    // }
+
+    // [AttributeUsage(System.AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
+    // public sealed class RequiresVersionAttribute : Attribute
+    // {
+    //     public int Version { get; set; }
+
+    //     public decimal Update { get; set; }
+
+    //     public RequiresVersionAttribute(int version) => Version = version;
+
+    //     public RequiresVersionAttribute(int version, int update) : this(version) => Update = update;
+    // }
+}