Merge branch 'AtlassianPS:master' into feature/IssueHistory

AtlassianPS · Aug 5, 2023 · be9fefb · be9fefb
2 parents fcf8392 + 109dc34
commit be9fefb
Show file tree

Hide file tree

Showing 12 changed files with 442 additions and 8 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -8,5 +8,8 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[*.md]
+[*.{md,yml,yaml}]
 trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1,3 +1,6 @@
-# https://help.github.com/articles/about-codeowners/
+.github/workflows               @atlassianps/ci-managers
+JiraPS.build.ps1                @atlassianps/ci-managers
+PPSScriptAnalyzerSettings.psd1  @atlassianps/ci-managers
+Tools/                          @atlassianps/ci-managers
 
-*       @atlassianps/maintainers @atlassianps/reviewers
+*                               @atlassianps/maintainers
diff --git a/.github/workflows/build_and_test.yml b/.github/workflows/build_and_test.yml
@@ -4,13 +4,22 @@ on:
   pull_request:
     branches:
       - master
+  push:
+    branches:
+      - master
 
 jobs:
   build_module:
     name: Build Module
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      - name: Setup PowerShell module cache
+        id: cacher
+        uses: actions/cache@v3
+        with:
+          path: "~/.local/share/powershell/Modules"
+          key: ${{ runner.os }}-PSModules
       - name: Setup
         shell: pwsh
         run: |
@@ -20,7 +29,7 @@ jobs:
         shell: pwsh
         run: |
           Invoke-Build -Task Clean, Build
-      - name: Upload
+      - name: Upload Artifact
         uses: actions/upload-artifact@v3
         with:
           name: Release
@@ -37,6 +46,12 @@ jobs:
         with:
           name: Release
           path: ./Release/
+      - name: Setup PowerShell module cache
+        id: cacher
+        uses: actions/cache@v3
+        with:
+          path: "~/.local/share/powershell/Modules"
+          key: ${{ runner.os }}-PSModules
       - name: Setup
         shell: powershell
         run: |
@@ -46,6 +61,12 @@ jobs:
         shell: powershell
         run: |
           Invoke-Build -Task Test
+      - name: Upload test results
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ runner.os }}-Unit-Tests
+          path: Test*.xml
+    if: ${{ always() }}
 
   test_on_windows_v7:
     name: Test Module on Windows (PS v7)
@@ -58,6 +79,12 @@ jobs:
         with:
           name: Release
           path: ./Release/
+      - name: Setup PowerShell module cache
+        id: cacher
+        uses: actions/cache@v3
+        with:
+          path: "~/.local/share/powershell/Modules"
+          key: ${{ runner.os }}-PSModules
       - name: Setup
         shell: pwsh
         run: |
@@ -67,6 +94,12 @@ jobs:
         shell: pwsh
         run: |
           Invoke-Build -Task Test
+      - name: Upload test results
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ runner.os }}-Unit-Tests
+          path: Test*.xml
+    if: ${{ always() }}
 
   test_on_ubuntu:
     name: Test Module on Ubuntu
@@ -79,6 +112,12 @@ jobs:
         with:
           name: Release
           path: ./Release/
+      - name: Setup PowerShell module cache
+        id: cacher
+        uses: actions/cache@v3
+        with:
+          path: "~/.local/share/powershell/Modules"
+          key: ${{ runner.os }}-PSModules
       - name: Setup
         shell: pwsh
         run: |
@@ -88,6 +127,12 @@ jobs:
         shell: pwsh
         run: |
           Invoke-Build -Task Test
+      - name: Upload test results
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ runner.os }}-Unit-Tests
+          path: Test*.xml
+    if: ${{ always() }}
 
   test_on_macos:
     name: Test Module on macOS
@@ -100,6 +145,12 @@ jobs:
         with:
           name: Release
           path: ./Release/
+      - name: Setup PowerShell module cache
+        id: cacher
+        uses: actions/cache@v3
+        with:
+          path: "~/.local/share/powershell/Modules"
+          key: ${{ runner.os }}-PSModules
       - name: Setup
         shell: pwsh
         run: |
@@ -109,6 +160,12 @@ jobs:
         shell: pwsh
         run: |
           Invoke-Build -Task Test
+      - name: Upload test results
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ runner.os }}-Unit-Tests
+          path: Test*.xml
+    if: ${{ always() }}
 
   test_against_cloud:
     env:
@@ -125,6 +182,12 @@ jobs:
         with:
           name: Release
           path: ./Release/
+      - name: Setup PowerShell module cache
+        id: cacher
+        uses: actions/cache@v3
+        with:
+          path: "~/.local/share/powershell/Modules"
+          key: ${{ runner.os }}-PSModules
       - name: Setup
         shell: pwsh
         run: |
@@ -135,3 +198,9 @@ jobs:
         run: |
           Invoke-Build -Task Test -Tag "Integration" -ExcludeTag ""
         if: ${{ env.JiraURI != '' }}
+      - name: Upload test results
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ runner.os }}-Unit-Tests
+          path: Test*.xml
+    if: ${{ always() }}
diff --git a/.github/workflows/pr_review.yml b/.github/workflows/pr_review.yml
@@ -0,0 +1,16 @@
+name: Refine PRs
+
+on:
+  pull_request:
+    types: [opened]
+
+jobs:
+  label_issue:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Add default reviewers to PR"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_URL: ${{ github.event.pull_request.html_url }}
+        run: |
+          gh pr edit $PR_URL --add-reviewer @atlassianps/reviewers
diff --git a/JiraPS/Public/Get-JiraIssueWorklog.ps1 b/JiraPS/Public/Get-JiraIssueWorklog.ps1
@@ -0,0 +1,66 @@
+function Get-JiraIssueWorklog {
+    # .ExternalHelp ..\JiraPS-help.xml
+    [CmdletBinding()]
+    param(
+        [Parameter( Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )]
+        [ValidateNotNullOrEmpty()]
+        [ValidateScript(
+            {
+                if (("JiraPS.Issue" -notin $_.PSObject.TypeNames) -and (($_ -isnot [String]))) {
+                    $exception = ([System.ArgumentException]"Invalid Type for Parameter") #fix code highlighting]
+                    $errorId = 'ParameterType.NotJiraIssue'
+                    $errorCategory = 'InvalidArgument'
+                    $errorTarget = $_
+                    $errorItem = New-Object -TypeName System.Management.Automation.ErrorRecord $exception, $errorId, $errorCategory, $errorTarget
+                    $errorItem.ErrorDetails = "Wrong object type provided for Issue. Expected [JiraPS.Issue] or [String], but was $($_.GetType().Name)"
+                    $PSCmdlet.ThrowTerminatingError($errorItem)
+                    <#
+                      #ToDo:CustomClass
+                      Once we have custom classes, this check can be done with Type declaration
+                    #>
+                }
+                else {
+                    return $true
+                }
+            }
+        )]
+        [Alias('Key')]
+        [Object]
+        $Issue,
+
+        [Parameter()]
+        [System.Management.Automation.PSCredential]
+        [System.Management.Automation.Credential()]
+        $Credential = [System.Management.Automation.PSCredential]::Empty
+    )
+
+    begin {
+        Write-Verbose "[$($MyInvocation.MyCommand.Name)] Function started"
+    }
+
+    process {
+        Write-DebugMessage "[$($MyInvocation.MyCommand.Name)] ParameterSetName: $($PsCmdlet.ParameterSetName)"
+        Write-DebugMessage "[$($MyInvocation.MyCommand.Name)] PSBoundParameters: $($PSBoundParameters | Out-String)"
+
+        # Find the proper object for the Issue
+        $issueObj = Resolve-JiraIssueObject -InputObject $Issue -Credential $Credential
+
+        $parameter = @{
+            URI          = "{0}/worklog" -f $issueObj.RestURL
+            Method       = "GET"
+            GetParameter = @{
+                maxResults = $PageSize
+            }
+            OutputType   = "JiraWorklogItem"
+            Paging       = $true
+            Credential   = $Credential
+        }
+
+        Write-Debug "[$($MyInvocation.MyCommand.Name)] Invoking JiraMethod with `$parameter"
+        Invoke-JiraMethod @parameter
+    }
+
+    end {
+        Write-Verbose "[$($MyInvocation.MyCommand.Name)] Complete"
+    }
+}
diff --git a/JiraPS/Public/Invoke-JiraMethod.ps1 b/JiraPS/Public/Invoke-JiraMethod.ps1
@@ -37,7 +37,8 @@ function Invoke-JiraMethod {
             "JiraComment",
             "JiraIssue",
             "JiraUser",
-            "JiraVersion"
+            "JiraVersion",
+            "JiraWorklogItem"
         )]
         [String]
         $OutputType,

diff --git a/JiraPS/Public/New-JiraSession.ps1 b/JiraPS/Public/New-JiraSession.ps1
@@ -3,7 +3,7 @@ function New-JiraSession {
     [CmdletBinding()]
     [System.Diagnostics.CodeAnalysis.SuppressMessage('PSUseShouldProcessForStateChangingFunctions', '')]
     param(
-        [Parameter( Mandatory )]
+        [Parameter( )]
         [System.Management.Automation.PSCredential]
         [System.Management.Automation.Credential()]
         $Credential,
@@ -29,8 +29,8 @@ function New-JiraSession {
             Method       = "GET"
             Headers      = $Headers
             StoreSession = $true
-            Credential   = $Credential
         }
+        if ($Credential) { $parameter.Add('Credential',$Credential) }
         Write-Debug "[$($MyInvocation.MyCommand.Name)] Invoking JiraMethod with `$parameter"
         $result = Invoke-JiraMethod @parameter