Very basic milestone support

Can get by id and update an MR's milestone
chris-peterson · Dec 19, 2024 · 6d2f952 · 6d2f952
1 parent 0590e37
commit 6d2f952
Show file tree

Hide file tree

Showing 8 changed files with 170 additions and 28 deletions.
diff --git a/src/GitlabCli/Branches.psm1 b/src/GitlabCli/Branches.psm1
@@ -12,27 +12,23 @@ function Get-GitlabProtectedBranchAccessLevel {
 function Get-GitlabBranch {
     [CmdletBinding(DefaultParameterSetName="ByProjectId")]
     param (
-        [Parameter(ParameterSetName="ByProjectId", Mandatory=$false, ValueFromPipelineByPropertyName)]
-        [Parameter(ParameterSetName="ByRef", Mandatory=$false, ValueFromPipelineByPropertyName)]
+        [Parameter(ParameterSetName="ByProjectId", ValueFromPipelineByPropertyName)]
+        [Parameter(ParameterSetName="ByRef", ValueFromPipelineByPropertyName)]
         [string]
         $ProjectId = '.',
 
-        [Parameter(ParameterSetName="ByProjectId",Mandatory=$false)]
+        [Parameter(ParameterSetName="ByProjectId")]
         [string]
         $Search,
 
-        [Parameter(ParameterSetName="ByRef", Mandatory=$true)]
+        [Parameter(ParameterSetName="ByRef", Mandatory, Position=0)]
         [Alias("Branch")]
         [string]
         $Ref,
 
-        [Parameter(Mandatory=$false)]
+        [Parameter()]
         [string]
-        $SiteUrl,
-
-        [switch]
-        [Parameter(Mandatory=$false)]
-        $WhatIf
+        $SiteUrl
     )
 
     $Project = Get-GitlabProject -ProjectId $ProjectId
@@ -48,7 +44,7 @@ function Get-GitlabBranch {
         SiteUrl    = $SiteUrl
     }
 
-    switch($PSCmdlet.ParameterSetName) {
+    switch ($PSCmdlet.ParameterSetName) {
         ByProjectId {
             if($Search) {
                 $GitlabApiArguments.Query["search"] = $Search
@@ -58,11 +54,11 @@ function Get-GitlabBranch {
             $GitlabApiArguments.Path += "/$($Ref)"
         }
         default {
-            throw "Parameterset $($PSCmdlet.ParameterSetName) is not implemented"
+            throw "$($PSCmdlet.ParameterSetName) is not implemented"
         }
     }
 
-    Invoke-GitlabApi @GitlabApiArguments -WhatIf:$WhatIf
+    Invoke-GitlabApi @GitlabApiArguments
         | New-WrapperObject 'Gitlab.Branch'
         | Add-Member -MemberType 'NoteProperty' -Name 'ProjectId' -Value $Project.Id -PassThru
         | Sort-Object -Descending LastUpdated

diff --git a/src/GitlabCli/Formats.ps1xml b/src/GitlabCli/Formats.ps1xml
@@ -180,6 +180,44 @@
         </TableRowEntries>
       </TableControl>
     </View>
+    <View>
+      <Name>GitlabMilestone</Name>
+      <ViewSelectedBy>
+        <TypeName>Gitlab.Milestone</TypeName>
+      </ViewSelectedBy>
+      <TableControl>
+        <TableHeaders>
+          <TableColumnHeader>
+          </TableColumnHeader>
+          <TableColumnHeader>
+          </TableColumnHeader>
+          <TableColumnHeader>
+          </TableColumnHeader>
+          <TableColumnHeader>
+            <Label>UpdatedAt</Label>
+          </TableColumnHeader>
+        </TableHeaders>
+        <TableRowEntries>
+          <TableRowEntry>
+            <TableColumnItems>
+              <TableColumnItem>
+                <PropertyName>Id</PropertyName>
+                <Alignment>Right</Alignment>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>Title</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>DueDate</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>UpdatedAtSortable</PropertyName>
+              </TableColumnItem>
+            </TableColumnItems>
+          </TableRowEntry>
+        </TableRowEntries>
+      </TableControl>
+    </View>
     <View>
       <Name>GitlabMergeRequestApprovalRule</Name>
       <ViewSelectedBy>

diff --git a/src/GitlabCli/GitlabCli.psd1 b/src/GitlabCli/GitlabCli.psd1
@@ -1,5 +1,5 @@
 @{
-    ModuleVersion = '1.121.0'
+    ModuleVersion = '1.122.0'
 
     RequiredModules = @('powershell-yaml')
 
@@ -27,7 +27,8 @@
             ExternalModuleDependencies = @('powershell-yaml')
             ReleaseNotes =
 @'
-* feature: Set build timeout for projects
+* feature: implement milestones
+* enhance: add options for issues/MRs
 '@
         }
     }
@@ -62,6 +63,7 @@
         'Jobs.psm1'
         'Members.psm1'
         'MergeRequests.psm1'
+        'Milestones.psm1'
         'Notes.psm1'
         'PersonalAccessTokens.psm1'
         'Pipelines.psm1'
@@ -192,6 +194,9 @@
         'New-GitlabMergeRequestApprovalRule'
         'Remove-GitlabMergeRequestApprovalRule'
 
+        # Milestones
+        'Get-GitlabMilestone'
+
         # PATs
         'Get-GitlabPersonalAccessToken'
         'New-GitlabPersonalAccessToken'

diff --git a/src/GitlabCli/Issues.psm1 b/src/GitlabCli/Issues.psm1
@@ -112,6 +112,10 @@ function New-GitlabIssue {
         [switch]
         $MarkTodoAsRead,
 
+        [Parameter()]
+        [switch]
+        $Follow,
+
         [Parameter()]
         [string]
         $SiteUrl
@@ -131,6 +135,9 @@ function New-GitlabIssue {
             $Todo = Get-GitlabTodo -SiteUrl $SiteUrl | Where-Object TargetUrl -eq $Issue.WebUrl
             Clear-GitlabTodo -TodoId $Todo.Id -SiteUrl $SiteUrl | Out-Null
         }
+        if ($Follow) {
+            Start-Process $Issue.WebUrl
+        }
         $Issue
     }
 }

diff --git a/src/GitlabCli/MergeRequests.psm1 b/src/GitlabCli/MergeRequests.psm1
@@ -227,9 +227,9 @@ function Add-GitlabMergeRequestChangeSummary {
 function New-GitlabMergeRequest {
     [CmdletBinding(SupportsShouldProcess)]
     param(
-        [Parameter(Position=0)]
+        [Parameter(Position=0, ValueFromPipelineByPropertyName)]
         [string]
-        $ProjectId,
+        $ProjectId = '.',
 
         [Parameter(Position=1)]
         [string]
@@ -243,6 +243,15 @@ function New-GitlabMergeRequest {
         [string]
         $Title,
 
+        [Parameter()]
+        [string]
+        $MilestoneId,
+
+        [Parameter()]
+        [Alias('NoTodo')]
+        [switch]
+        $MarkTodoAsRead,
+
         [Parameter()]
         [switch]
         $Follow,
@@ -270,20 +279,30 @@ function New-GitlabMergeRequest {
 
     $Me = Get-GitlabCurrentUser
 
+    $Body = @{
+        source_branch        = $SourceBranch
+        target_branch        = $TargetBranch
+        remove_source_branch = 'true'
+        assignee_id          = $Me.Id
+        title                = $Title
+    }
+    if ($MilestoneId) {
+        $Body.milestone_id = $MilestoneId
+    }
+
     $Request = @{
         Method = 'POST'
-        Path   = "projects/$($Project.Id)/merge_requests"
-        Body   = @{
-            source_branch        = $SourceBranch
-            target_branch        = $TargetBranch
-            remove_source_branch = 'true'
-            assignee_id          = $Me.Id
-            title                = $Title
-        }
+        # https://docs.gitlab.com/ee/api/merge_requests.html#create-mr
+        Path = "projects/$($Project.Id)/merge_requests"
+        Body = $Body
     }
 
-    if ($PSCmdlet.ShouldProcess("$($Project.PathWithNamespace)", "create merge request ($($Request | ConvertTo-Json))")) {
+    if ($PSCmdlet.ShouldProcess("$($Project.PathWithNamespace)", "create merge request ($($Body | ConvertTo-Json))")) {
         $MergeRequest = Invoke-GitlabApi @Request -SiteUrl $SiteUrl | New-WrapperObject 'Gitlab.MergeRequest'
+        if ($MarkTodoAsRead) {
+            $Todo = Get-GitlabTodo -SiteUrl $SiteUrl | Where-Object TargetUrl -eq $MergeRequest.WebUrl
+            Clear-GitlabTodo -TodoId $Todo.Id -SiteUrl $SiteUrl | Out-Null
+        }
         if ($Follow) {
             Start-Process $MergeRequest.WebUrl
         }
@@ -436,6 +455,10 @@ function Update-GitlabMergeRequest {
         [switch]
         $Reopen,
 
+        [Parameter()]
+        [string]
+        $MilestoneId,
+
         [Parameter()]
         [string]
         $SiteUrl
@@ -476,6 +499,9 @@ function Update-GitlabMergeRequest {
     } elseif ($UnsetReviewers) {
         $Request.reviewer_ids = @()
     }
+    if ($MilestoneId) {
+        $Request.milestone_id = $MilestoneId
+    }
 
     if ($PSCmdlet.ShouldProcess("MR $MergeRequestId in $($Project.PathWithNamespace)", "update $($Request | ConvertTo-Json)")) {
         # https://docs.gitlab.com/ee/api/merge_requests.html#update-mr

diff --git a/src/GitlabCli/Milestones.psm1 b/src/GitlabCli/Milestones.psm1
@@ -0,0 +1,62 @@
+function Get-GitlabMilestone {
+    [CmdletBinding(SupportsShouldProcess, DefaultParameterSetName = 'ByGroup')]
+    param (
+
+        [Parameter(ValueFromPipelineByPropertyName, ParameterSetName = 'ByGroup')]
+        [string]
+        $GroupId,
+
+        [Parameter(ValueFromPipelineByPropertyName, ParameterSetName = 'ByProject')]
+        [string]
+        $ProjectId,
+
+        [Parameter(ParameterSetName = 'ByGroup')]
+        [Parameter(ParameterSetName = 'ByProject')]
+        [Alias('Id')]
+        [string]
+        $MilestoneId,
+
+        [Parameter()]
+        [string]
+        $SiteUrl
+    )
+
+    if ($MilestoneId) {
+        $Data = Invoke-GitlabGraphQL -Query @"
+        {
+            milestone(id: "gid://gitlab/Milestone/$MilestoneId") {
+                groupMilestone,
+                group {
+                id
+                }
+                projectMilestone,
+                project {
+                id
+                }
+            }
+        }
+"@
+        if ($Data.Milestone.groupMilestone) {
+            $GroupId = $Data.Milestone.group.id -split '/' | Select-Object -Last 1
+        }
+        elseif ($Data.Milestone.projectMilestone) {
+            $ProjectId = $Data.Milestone.project.id -split '/' | Select-Object -Last 1
+        }
+
+    }
+
+    $Resource = ''
+    if ($GroupId) {
+         $Resource = "groups/$GroupId/milestones"
+    } elseif ($ProjectId) {
+         $Resource = "projects/$ProjectId/milestones"
+    }
+
+    $Request = @{
+        HttpMethod = 'GET'
+        Path       = $Resource
+        SiteUrl    = $SiteUrl
+    }
+
+    Invoke-GitlabApi @Request | New-WrapperObject 'Gitlab.Milestone'
+}
diff --git a/src/GitlabCli/Types.ps1xml b/src/GitlabCli/Types.ps1xml
@@ -81,6 +81,15 @@
       </ScriptProperty>
     </Members>
   </Type>
+  <Type>
+    <Name>Gitlab.Milestone</Name>
+    <Members>
+      <ScriptProperty>
+        <Name>UpdatedAtSortable</Name>
+        <GetScriptBlock>$this.UpdatedAt.ToString('yyyy-MM-dd HH:mm')</GetScriptBlock>
+      </ScriptProperty>
+    </Members>
+  </Type>
   <Type>
     <Name>Gitlab.MergeRequestApprovalRule</Name>
     <Members>

diff --git a/src/GitlabCli/_Init.ps1 b/src/GitlabCli/_Init.ps1
@@ -17,8 +17,6 @@ $global:GitlabConsoleColors     = @{
     White       = '1;37'
     Yellow      = '1;33'
 }
-# https://docs.gitlab.com/ee/api/#id-vs-iid
-# TL;DR; it's a mess and we have to special-case specific entity types
 $global:GitlabIdentityPropertyNameExemptions=@{
     'Gitlab.AuditEvent'                = 'Id'
     'Gitlab.AccessToken'               = 'Id'
@@ -33,6 +31,7 @@ $global:GitlabIdentityPropertyNameExemptions=@{
     'Gitlab.Job'                       = 'Id'
     'Gitlab.Member'                    = 'Id'
     'Gitlab.MergeRequestApprovalRule'  = 'Id'
+    'Gitlab.Milestone'                 = 'Iid'
     'Gitlab.NewPersonalAccessToken'    = 'Id'
     'Gitlab.Note'                      = 'Id'
     'Gitlab.PersonalAccessToken'       = 'Id'