Merge pull request #129 from StartAutomating/ADOPermissions

Updating Get/Set-ADOPermission:

CHANGELOG.md

@@ -0,0 +1,334 @@
+0.5.6:
+---
+### Azure DevOps Improvements
+* Get-ADOPermission    :  Can now get permissions related to Dashboards, Analytics, AreaPaths, and IterationPaths
+* Set-ADOPermission    :  Now can easily set permissions based off of a variety of pipeline inputs (Fixes #128 and #91)
+* Get-ADOAreaPath      :  Removing "Area" from paths passed in, formatting returns with 'AreaPath' instead of 'Path'
+* Get-ADOIterationPath :  Removing "Iteration" from paths passed in, formatting returns with 'IterationPath' instead of 'Path'
+* Get-ADOBuild         :  Extended Type Definitions now contain an alias property of BuildPath
+### GitHub Workflow Improvements
+* Adding "On" files for issue creation, deletion, or modification (Fixes #132)
+* Adding "On" files for common scheduling needs (Fixes #134)
+* ReleaseNameFormat can not be customized in ReleaseModule step (Fixes #130)
+
+0.5.5.1:
+---
+* Allowing for [Reflection.AssemblyMetaData] attributes on step .ps1 files (to customize YAML).  Issue #123
+* Better support for Object and array parameters in Azure DevOps. Issue #125.
+
+0.5.5:
+---
+* Azure DevOps: Adding support for Shared Queries (Fixes #117)
+** Get-ADOWorkItem -SharedQuery can get shared queries
+** New-ADOWorkItem -WIQL will create shared queries.  -FolderName will create folders.
+** Remove-ADOWorkItem -QueryID can remove a shared query by ID
+* GitHub Workflows:
+** Adding Job/Step definitions to Release Module
+** Adding -NoCoverage to RunPester Step
+** Creating Example workflow that publishes PSDevOps.
+
+0.5.4.2:
+---
+* Adding Register-ADOArtifactFeed (Fixes #118)
+
+0.5.4.1:
+---
+* Fixing Invoke-ADORestApi issues:  #111,#114,#115
+* Attaching .BuildID and .DefinitionID properties to Get-ADOBuild where appropriate.
+
+0.5.4:
+---
+* Formatting Improvments:
+** Get-ADOField now includes .Type
+** Get-ADOExtension now includes .Version
+* Set-ADOTeam -DefaultAreaPath/-AreaPath parameter set issue fixed (fixes #103 / #92)
+** Added tests for Set-ADOTeam
+* GitHub Workflow Definition Improvements:
+** New Triggers:
+*** On PullToMain
+** New Jobs:
+*** UpdateModuleTag
+*** PublishToGallery
+** New Steps:
+*** PublishPowerShellGallery
+*** TagModuleVersion
+* New-GitHubWorkflow/New-ADOPipeline now support -RootDirectory
+* Fixing pluralization / list issue with multiple GitHub Workflow "On"
+0.5.3
+---
+* Get-ADORepository  :  Adding -PullRequestID
+* New/Set-ADOWorkItem:  Fixing pipelining issue
+
+0.5.2
+---
+* Get-ADOTeam:  Adding alias -AreaPath for -TeamFieldValue, carrying on team property
+* Set-ADOTeam:  Support for -DefaultAreaPath/-AreaPath (TeamFieldValues api, fixing issue #92)
+* Get-ADOTest:  Enabling pagination and filtering of results.
+** Invoke-ADORestAPI:  Fixing -Cache(ing) correctly (#88)
+** Invoke-GitHubRESTAPI: Only using .ContentEncoding if present in results (PowerShell core fix)
+* Get-ADOWorkItem:
+** Fixing -Related (#79)
+** Fixing -Comment errors when there are no commments (#80)
+* New/Set-ADOWorkItem:
+** Adding -Relationship and -Comment (#81)
+** Improving Formatting of Work Items (#82)
+** Adding -Tag
+* Invoke-ADORestAPI:  Fixing issue with -QueryParameter
+0.5.1
+---
+* Bugfixes:
+** Get-ADOTest:  Fixing parameter sets and adding formatting.
+** Invoke-GitHubRESTAPI:  Only using .ContentEncoding when present.
+0.5
+---
+* Improved Git Functionality
+** New-GitHubAction
+** Invoke-GitHubRESTApi
+** Connect/Disconnect-GitHub (enabling smart aliases like api.github.com/zen and api.github.com/repos/<owner>/<repo>)
+** Formatting for GitHub Issues and Repos
+* Azure DevOps Additions/Fixes
+** Invoke-ADORestAPI -AsJob
+
+** Get-ADOArtifactFeed now has -Metric, -PackageList, -PackageVersionList, -Provenance
+** Get-ADOIdentity [new]
+** Get-ADOProject now has -Board, -TestVariable, -TestConfiguration
+** Get-ADOPermission is now more API-complete and has parameter sets for permission types
+** Set-ADOPermission
+** Get-ADOExtension can now read extension data
+** Set-ADOExtension can now set extension data
+** Get-ADOTest [new]
+** New-ADOPipeline now has -RootDirectory
+** Tons of New Type Definitions and Formatters
+
+0.4.9
+---
+* New Command: Wait-ADOBuild
+* Start-ADOBuild
+** Supports -Debug (to start a build with extra tracing)
+** Allows parameters as PSObject
+* Get-ADORepository:  Added -IncludeHidden, -IncludeRemoteURL, -IncludeLink
+* Improvements to Pipelines and Workflows:
+** Pester, PSScriptAnalyzer, and ScriptCop now produce output variables
+** PSDevOps now includes a file to generate it's own build
+** PublishTest/CodeCoverage Results steps will always() run
+** Convert-BuildStep will add a .Name to each script step.
+
+0.4.8
+---
+* Improved Tracing
+** New Commands: Write-ADOOutput, Trace-ADOCommand/GitHubCommand
+** Renaming Command / Adding Parameters:  Set-ADOVariable -> Write-ADOVariable.  Added -IsOutput & -IsReadOnly.
+** Adding Trace-GitHubCommand/ADOCommand
+** Improved logging of parameters in Convert-BuildStep
+* New Functionality in Azure DevOps:
+** Get-ADOProject now has -TestRun, -TestPlan, -Release, and -PendingApproval (and better progress bars)
+** Get-ADOWorkItemType now has -Field
+** Commands for Picklists:  Add/Get/Remove/Update-ADOPicklist
+0.4.7
+----
+* New Commands:
+** Add/Get/Remove-ADOWiki
+** Get-ADOPermission
+* Bugfixes:
+** Honoring Get-ADOBuild -DefinitionName
+* Disconnect-ADO is now run prior at the start of Connect-ADO, and on module unload.
+0.4.6
+---
+* New-ADOPipeline/New-GitHubWorkflow:  Adding -BuildScript
+* Connect-ADO:  Auto-detecting connected user's teams and adding tab completion for -Project/-ProjectID/-Team/-TeamID
+* Convert-BuildStep: Re-ordering YAML for GitHub Workflows (putting .runs last)
+* Convert-ADOPipeline:  Not returning .inputs when there are no .inputs
+* Get-ADOProject:  Adding -PolicyType and -PolicyConfiguration
+* Get-ADORepository:  Adding -PullRequest, -SourceReference, -TargetReference, -ReviewerIdentity, -CreatorIdentity.
+* Get-ADOBuild:  Adding -DefinitionName
+* Invoke-ADORestAPI:  Passing content length of 0 when body is empty.
+* Updating README
+0.4.5
+---
+* New Commands:
+** Connect/Disconnect-ADO:  Caching connection info and saving default parameters!
+** New-ADOBuild          :  Create build definitions!
+** Remove-ADOAgentPool   :  Cleaning up pools, queues, and agents.
+* Core Improvements
+** Invoke-ADORestApi
+*** Now supports -ContinuationToken (and auto-continues unless passed a $first or $top query parameter)
+*** Caches access tokens.
+*** BREAKING: Invoke-ADORestApi No longer has -Proxy* parameters.
+* Updated Commands:
+** Get-ADOUser/Get-ADOTeam : Additional Graph scenarios added.
+** New/Set-ADOWorkItem     : Added -BypassRule, -ValidateOnly, -SkipNotification
+0.4.4
+---
+* Get-ADOTask:  Adding -YAMLSchema.
+* Get-ADOTeam:  Adding -Setting/-FieldValue/-Iteration/-Board.
+* Get-ADOAreaPath/ADOIterationPath:  Making parameter names match cmdlet.  Honoring -AreaPath/-IterationPath.
+* Get-ADOProject:  Adding -ProcessConfiguration, -Plan, -PlanID, and -DeliveryTimeline.
+* New Command:  Set-ADOTeam
+0.4.3
+---
+*Renaming commands:
+** New-ADODashboard -> Add-ADODashboard
+** New-ADOTeam -> Add-ADOTeam
+* Add-ADOTeam can now add members to a team
+* Get-ADOTeam can now get an -Identity
+* New Command: Get-ADOUser
+* Get-ADOAgentPool:  Fixed pipelining bug, added -AgentName/-IncludeCapability/-IncludeLastCompletedRequest/-IncludeAssignedRequest.
+* Set-ADOProject:  Can now -EnableFeature and -DisableFeature
+0.4.2
+---
+* Build Step Improvements:
+** New-ADOPipeline now has -PowerShellCore and -WindowsPowerShell
+** Import-BuildStep now has parameter sets
+** New-ADOPipeline/New-GitHubWorkflow now refer to a metadata collection based off of their noun.
+** BuildStep directories can be aliased:
+*** ADOPipeline directories can be: ADOPipeline, ADO, AzDo, and AzureDevOps.
+*** GitHubWorkflow directories can be: GitHubWorkflow, GitHubWorkflows, and GitHub.
+* New Dashboard Commands: Clear/Update-ADODashboard
+* New Extension Commands: Enable/Disbale-ADOExtension
+* Improved formatting/types for Extensions.
+* Breaking change: Install/Uninstall-ADOExtension now accept -PublisherID and -ExtensionID, not -PublisherName and -ExtensionName.
+0.4.1
+---
+* More GitHub Functionality:
+** Write-GitHubDebug
+** Write-GitHubOutput
+** Hide-GitHubOutput
+** New-GitHubWorkflow allows for more complex event mapping.
+* Azure DevOps Pipeline Changes
+** Convert-BuildStep once again converts using ${{parameters}} syntax
+* New/Improved Azure DevOps Cmdlets
+** Get/New/Remove-ADODashboard
+** Get-ADOAgentPool now supports -PoolID
+** Set-ADOProject
+** Repositories returned from a build definition are now decorated as PSDevOps.Repository
+* Improved testing and static analysis compliance
+0.4
+---
+* Overhaul of GitHub Workflow functionality.
+** New-GitHubAction renamed to New-GitHubWorkflow
+** /GitHubActions renamed to /GitHub
+** Added -EventParameter to allow for parameters from events such as workflow_dispatch
+** Added Write-GitHubError/GitHubWarning (updating Write-ADOError/Write-ADOWarning for consistency)
+** Cleaning up GitHub Workflow parts
+* Get-ADOTask no longer has -ApiVersion parameter
+0.3.9
+---
+* New/Get/Remove-ADOWorkItemType:  Create/get/remove work custom work item types, states, rules, and behaviors.
+* Added Get-ADOBuild -IncludeAllProperty/-IncludeLatestBuild.
+* ScriptCop Integration:  PowerShelllStaticAnalysis stage now runs ScriptCop as well.
+* Improved ScriptAnalyzer Integration: Rule name is now outputted.
+0.3.8
+---
+* Add/Remove-ADOAreaPath
+* Formatter for AreaPaths
+
+0.3.7
+---
+* Convert-ADOPipeline now has -Passthru and -Wherefore
+* Get-ADOWorkProcess now has -Behavior and -WorkItemType
+* Get-ADOWorkItem now has -Mine, -CurrentIteration, -Comment, -Update, -Revision.
+
+0.3.6.1
+---
+* Convert-ADOPipeline now binds to .Variables property
+* Fixing bug in PSDevOps.WorkItem types file, which displayed in formatting.
+0.3.6
+---
+* Added: Get-ADOTask, Convert-ADOPipeline
+0.3.5
+---
+* New Command: Get-ADOTeam
+* Get-ADOBuild -CodeCoverage
+* Progress bars on Get-ADORepository
+* Slight refactoring to make progress bars easier in any function
+
+0.3.4.1
+---
+* Removing supplied parameters in commands generated by Import-ADOProxy.
+0.3.4
+---
+* New capability: Import-ADOProxy (Import a proxy module with for your ADO / TFS instance)
+* New REST Commands: Get-ADOAreaPath, Get-ADOIterationPath, Get-ADOExtension
+* More Features: Get-ADORepository -FileList
+* Massive Internal Refactoring (switching to dynamic parameters for -PersonalAccessToken etc, standardizing pstypenames)
+0.3.3
+---
+* Now Caching Personal Access Tokens!
+* URLEncoding all segments in Parts/ReplaceRouteParameter.
+* Ensuring all Azure DevOps YAML Parameters are wrapped in a string.
+0.3.2
+---
+* Pester workarounds - Steps/InstallPester and Steps/RunPester now accept a PesterMaxVersion (defaulting to 4.99.99)
+* Convert-BuildStep handles blank parameter defaults correctly
+* Get-ADOBuild can get yaml definitions directly, e.g Get-ADOBuild -DefinitionID 123 -DefinitionYaml
+0.3.1
+---
+* Bugfixes and Improvements to Convert/Import/Expand-BuildStep:
+1. Enforcing pluralization of certain fields within Azure DevOps
+2. Handling [string[]], [int[]], [float[]], or [ScriptBlock] parameters
+* Allowing lists of primitives to not be indented in YAML.
+0.3.0
+---
+* Added Convert/Import/Expand-BuildStep
+* Allowing build steps to be defined in functions
+* Automagically importing build step parameters
+0.2.9
+---
+* Get/New/Remove-ADORepository
+* Get/New/Remove-ADOServiceEndpoint
+* Get-ADOAgentPool
+** Improvements to New-ADOPipeline to avoid unexpected singletons
+0.2.8
+---
+* Get/New/Update-ADOBuild
+* Improving New-ADOPipeline:
+** Unknown -InputObject properties will no longer be pluralized
+** Added 'Pool' to list of known singletons
+0.2.7
+---
+* New Cmdlet: Set-ADOArtifactFeed
+* Improvements to New/Get/Remove-ADOArtifactFeed (better pipelining, renaming -FullyQualifiedID to -FeedID)
+0.2.6
+---
+* New Cmdlets:
+** New/Get/Remove-ADOArtifactFeed
+** New/Remove-ADOProject
+** New-GitHubAction
+0.2.5
+---
+* Improving Get-ADOWorkItem:
+** -Title allows getting work items by title
+** -NoDetail allows for queries to only return IDs
+** Passing -Field will skip formatting
+** WorkItemsBatch will be used for query results.
+** Passing an old -ApiVersion will not use workItemsBatch
+** Formatting improved
+* Adding Get-ADOWorkProcess
+* Fixing issues with -ADOField commands when not provided a -Project
+0.2.4
+---
+* Adding Adding -CanSortBy, -IsQueryable, and -ReadOnly to New-ADOField.
+* Adding parameter help to New-ADOField
+0.2.3
+---
+* Adding New/Remove-ADOField
+* Adding help to Get-ADOField
+* Adding formatting for fields
+0.2.2
+---
+* Adding New/Set/Remove-ADOWorkItem
+* Adding Get-ADOField
+* New Parameter: Get-ADOWorkItem -WorkItemType
+* New Parameter: New-ADOPipeline -Option
+* Initial formatting
+* Switching Parts to use latest VMImage
+
+0.2.1 :
+* Added Get-ADOWorkItem
+---
+0.2   :
+---
+* Added Invoke-ADORestAPI
+0.1    :
+---
+Initial Commit

Formatting/PSDevOps.AreaPath.format.ps1

@@ -1 +1 @@
-Write-FormatView -TypeName PSDevOps.AreaPath -Property Organization, Path
+Write-FormatView -TypeName PSDevOps.AreaPath -Property Organization, AreaPath

Formatting/PSDevOps.IterationPath.format.ps1

@@ -1 +1 @@
-Write-FormatView -TypeName PSDevOps.IterationPath -Property Path, StartDate, EndDate -AutoSize
+Write-FormatView -TypeName PSDevOps.IterationPath -Property IterationPath, StartDate, EndDate -AutoSize

Get-ADOAreaPath.ps1

@@ -86,7 +86,7 @@
                 "$server".TrimEnd('/')   # the Server (minus any trailing slashes),
                 (. $ReplaceRouteParameter $PSCmdlet.ParameterSetName) # and any parameterized URLs in this parameter set.
                 if ($AreaPath) {
-                    $AreaPath
+                    $AreaPath -replace '\\','/' -replace '.+/Area' -replace '^/'
                 }
             ) -as [string[]] -ne '' -join '/'
 

Get-ADOIterationPath.ps1

@@ -84,7 +84,7 @@
                 "$server".TrimEnd('/')   # the Server (minus any trailing slashes),
                 (. $ReplaceRouteParameter $PSCmdlet.ParameterSetName) # and any parameterized URLs in this parameter set.
                 if ($IterationPath) {
-                    $IterationPath
+                    $IterationPath -replace '\\','/' -replace '.+/Iteration' -replace '^/'
                 }
             ) -as [string[]] -ne '' -join '/'