SA-3610 GHA Migration

.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# jcapi-powershell Code Owners
+
+* @TheJumpCloud/solutions-architecture

.github/workflows/jcapi-powershell-release.yml

@@ -0,0 +1,113 @@
+name: Release and Publish SDKs
+
+on:
+  pull_request:
+    types:
+      - closed
+    branches:
+      - master
+jobs:
+  Check-If-Merged:
+    if: github.event.pull_request.merged == true
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check if Merged
+        run: echo {GITHUB_HEAD_REF} merged into master
+  Check-PR-Labels:
+    needs: ["Check-If-Merged"]
+    runs-on: ubuntu-latest
+    outputs:
+      RELEASE_TYPE: ${{ steps.validate.outputs.RELEASE_TYPE }}
+    steps:
+      - name: Validate-PR-Version-Labels
+        id: validate
+        shell: pwsh
+        run: |
+          $PR_LABEL_LIST=$(curl -s "https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/labels" | jq -r '.[].name')
+          if ("SDK" -in $PR_LABEL_LIST) {
+              write-host "Starting Build for PowerShell SDK Release"
+          }
+          # validate type from label list:
+          $types = @('major', 'minor', 'patch', 'manual')
+          $typeCount = 0
+          foreach ($item in $PR_LABEL_LIST) {
+              if ($item -in $types) {
+                  write-host "$item"
+                  $typeCount += 1
+                  $RELEASE_TYPE = $item
+              }
+          }
+          if ($typeCount -eq 1) {
+              echo "RELEASE_TYPE=$RELEASE_TYPE" >> $env:GITHUB_OUTPUT
+          } else {
+              throw "Multiple or invalid release types were found on PR"
+              exit 1
+          }
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  Draft-GH-Release:
+    needs: ['Check-PR-Labels']
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        sdkName: ['JumpCloud.SDK.V1','JumpCloud.SDK.V2','JumpCloud.SDK.DirectoryInsights']
+    steps:
+      - uses: actions/checkout@v4
+      - name: Zip SDK Directory
+        run: |
+          cd ${{ github.workspace }}/SDKs/PowerShell/${{ matrix.sdkName }}/;
+          zip -r ${{ github.workspace }}/SDKs/PowerShell/${{ matrix.sdkName }}.zip ./*
+      - name: Build Draft Release
+        run: |
+          MODULE_CAPTURE=$(grep -Po "ModuleVersion = '(\d+\.\d+\.\d+)'" ${{ github.workspace }}/SDKs/PowerShell/${{ matrix.sdkName }}/${{ matrix.sdkName }}.psd1)
+          VERSION=$(echo $MODULE_CAPTURE | grep -Po "(\d+\.\d+\.\d+)")
+          TITLE="${{ matrix.sdkName }}-$VERSION"
+          # Get the changelog text between the latest release # and the next sequential "## SemanticVersionNumber"
+          CHANGELOG=$(cat ${{ github.workspace }}/${{ matrix.sdkName }}.md | awk "/^## ${{ matrix.sdkName }}-$VERSION/{ f = 1; next } /## ${{ matrix.sdkName }}-[0-9]+.[0-9]+.[0-9]+/{ f = 0 } f")
+          BODY="$TITLE $CHANGELOG"
+          TAG="${{ matrix.sdkName }}-$VERSION"
+          BODY="$TITLE $CHANGELOG"
+          # draft release
+          (gh release view $TAG && echo "Release exists for $TAG") || gh release create $TAG --title "$TITLE" --notes "$BODY" --draft
+          # add artifact:
+          gh release upload $TAG ${{ github.workspace }}/SDKs/PowerShell/${{ matrix.sdkName }}.zip
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  Manual-Approval-Release:
+    needs: ["Draft-GH-Release"]
+    environment: PublishToPSGallery
+    runs-on: ubuntu-latest
+    steps:
+      - name: Manual Approval for Release
+        run: echo "Awaiting approval from required reviewers before continuing"
+  Deploy-Nupkg:
+    needs: ['Manual-Approval-Release']
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+          SDKName: ['JumpCloud.SDK.DirectoryInsights', 'JumpCloud.SDK.V1', 'JumpCloud.SDK.V2']
+    steps:
+      - name: Download SDK Artifact
+        run: |
+          WF_NAME="jcapi-powershell-ci.yml"
+          ARTIFACT_NAME="build-${{ matrix.SDKName }}"
+          RUN_ID=`gh run --repo ${{ github.repository }} list --workflow ${WF_NAME} --branch ${{ github.ref_name }} --json databaseId --jq .[0].databaseId`
+          gh run --repo ${{ github.repository }} download ${RUN_ID} -n ${ARTIFACT_NAME}
+          # List the artifiact directory/files
+          ls -lR
+          unzip ${{ matrix.SDKName }}.zip
+        env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Publish SDKs
+        shell: pwsh
+        run: |
+          # finally remove source PSGallery and add again with the v2/package path for publishing
+          dotnet nuget remove source PSGallery
+          dotnet nuget add source "https://www.powershellgallery.com/api/v2/package" --name PSGallery
+          $NupkgPath = (Get-ChildItem -Path:("./${{ matrix.sdkName }}/bin/nupkg/${{ matrix.sdkName }}*.nupkg")).FullName
+          write-host "push ${{ matrix.sdkName }} to psgallery"
+          # nuget push from here:
+          dotnet nuget push $NupkgPath --source PSGallery --api-key $env:NuGetApiKey
+        env:
+          NuGetApiKey: ${{ secrets.NUGETAPIKEY }}

ApiTransform.ps1

@@ -46,14 +46,14 @@ $TransformConfig = [Ordered]@{
             # new model CommandResultByCommandID
             '"title":"CommandResult","type":"object"},"commandresultslist"'                                                                                                                                                         = '"title":"CommandResult","type":"object"},"commandresultbycommandid":{"properties":{"_id":{"description":"The ID of the command.","type":"string"},"command":{"description":"The command that was executed on the system.","type":"string"},"files":{"description":"An array of file ids that were included in the command","items":{"type":"string"},"type":"array"},"name":{"description":"The name of the command.","type":"string"},"organization":{"description":"The ID of the organization.","type":"string"},"requestTime":{"description":"The time that the command was sent.","format":"date-time","type":"string"},"response":{"properties":{"data":{"properties":{"exitCode":{"description":"The stderr output from the command that ran.","type":"integer"},"output":{"description":"The output of the command that was executed.","type":"string"}},"type":"object"},"error":{"description":"The stderr output from the command that ran.","type":"string"},"id":{"description":"ID of the response.","type":"string"}},"type":"object"},"responseTime":{"description":"The time that the command was completed.","format":"date-time","type":"string"},"sudo":{"description":"If the user had sudo rights","type":"boolean"},"system":{"description":"The name of the system the command was executed on.","type":"string"},"user":{"description":"The user the command ran as.","type":"string"},"workflowId":{"type":"string"},"workflowInstanceId":{"type":"string"}},"title":"CommandResultByCommandID","type":"object"},"commandresultslist"'
             # replace def commandresult with commandresultbycommandid in
-            '{"\$ref":"#\/definitions\/commandresult"},"type":"array"}}},"security":\[{"x-api-key":\[\]}\],"summary":"Get results for a specific command"'                                                                          = '{"$ref":"#/definitions/commandresultbycommandid"},"type":"array"}}},"security":[{"x-api-key":[]}],"summary":"Get results for a specific command"
-'
+            '{"\$ref":"#\/definitions\/commandresult"},"type":"array"}}},"security":\[{"x-api-key":\[\]}\],"summary":"Get results for a specific command"'                                                                          = '{"$ref":"#/definitions/commandresultbycommandid"},"type":"array"}}},"security":[{"x-api-key":[]}],"summary":"Get results for a specific command"'
             '\/systemuserputpost"}},{"\$ref":"#\/parameters\/trait:multiTenantRequestHeaders:x-org-id"},{.*?"in":"query"'                                                                                                           = '/systemuserputpost"}},{"in":"query"' # Remove very large query description, it breaks Autorest's ability to build the parameter
             '\/systemuserput"}},{"\$ref":"#\/parameters\/trait:multiTenantRequestHeaders:x-org-id"},{.*?"in":"query"'                                                                                                               = '/systemuserput"}},{"in":"query"' # Remove very large query description, it breaks Autorest's ability to build the parameter
             '"enrollmentType":{"enum":\["unknown","automated device","device","user"\],"type":"string"},"internal":{"properties":{"deviceId":{"type":"string"},"windowsDeviceId":{"type":"string"}},"type":"object"}'               = '' # error CS0262: Partial declarations of 'IJcSystemMdmInternal' have conflicting accessibility modifiers; error CS0535: 'JcSystemMdm' does not implement interface member 'IJcSystemMdmInternal.DeviceId'
             '"systems":{"description":"Not used. Use \/api\/v2\/commands\/{id}\/associations to bind commands to systems.","items":{"type":"string"},"type":"array"}'                                                               = '' # remove unused commands system param
             '"basePath":"\/api"'                                                                                                                                                                                                    = '"basePath":"/api/"'; # The extra slash at the end is needed to properly build the url.
             '"type":"null"'                                                                                                                                                                                                         = '"type":"string"'; # A type of null is not valid.
+            '"type":\["object","null"\]'                                                                                                                                                                                                                                                               = '"type":"object"'
             '{"description":"This is an optional flag that can be enabled on the DELETE call.*?","in":"query","name":"cascade_manager".*?"}'                                                                                        = ''; # TODO: Add this back in eventually - fix to remove the cascade manager param from delete user (autorest thinks multiple matching 'break' parameters are declared in the delete function)
             '"produces":\["application\/json","text\/plain"\]'                                                                                                                                                                      = '';
             '"responses":{"200":{"description":"OK","schema":{"type":"string"}}'                                                                                                                                                    = '"responses":{"200":{"description":""}';
@@ -89,6 +89,7 @@ $TransformConfig = [Ordered]@{
             'commands_list'                  = 'Command_List';
             'commands_post'                  = 'Command_Create';
             'commands_put'                   = 'Command_Set';
+            'commands_run'                   = 'Commands_Run';
             'organization_list'              = 'Organization_List';
             'organization_put'               = 'Organization_Set';
             'organizations_get'              = 'Organization_Get';
@@ -139,7 +140,6 @@ $TransformConfig = [Ordered]@{
             '"format":"uint32"'                                                                                                                                       = '"format":"int64"' # SI code uses uint32 which is larger than int32 . Swagger 2 doesnt have a concept of uint32 . AutoRest defaults to int32 when it sees a type of integer.
             '"produces":\["text\/html"\]'                                                                                                                             = '' # produces text/html is not valid, just remove
             # Filter Customizations (define filter as list)
-            '"in":"query","items":{"type":"string"},"name":"filter","type":"array"},"trait:folderId:folderId":'                                                       = '"in":"query","items":{"type":"string"},"name":"filter","type":"array","collectionFormat":"multi","x-ms-skip-url-encoding":true},"trait:folderId:folderId":'
             # Custom Tweaks
             '"operationId":"gsuites_listImportUsers","parameters":\[{"\$ref":"#\/parameters\/trait:limit:limit"},{"\$ref":"#\/parameters\/trait:gsuite:maxResults"},' = '"operationId":"gsuites_listImportUsers","parameters":[{"$ref":"#/parameters/trait:gsuite:maxResults"},' # Get-JCsdkGsuiteUsersToImport does not require a limit parameter
             '"responses":{"201":{"description":"","schema":{"\$ref":"#\/definitions\/job-id"}}'                                                                       = '"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/job-id"}}'; # Workaround incorrectly defined 201 response in swagger should be 200; affects New-JcSdkBulkUser

BuildAutoRest.ps1

@@ -22,7 +22,6 @@ Param(
 )
 # https://github.com/Azure/autorest/blob/master/docs/powershell/options.md
 # CI Variables
-$CI_USERNAME = 'TheJumpCloud'
 $CurrentBranch = If ([System.String]::IsNullOrEmpty($env:CIRCLE_BRANCH)) { git branch --show-current } Else { $env:CIRCLE_BRANCH }
 $BuildNumber = If ([System.String]::IsNullOrEmpty($env:CIRCLE_BUILD_NUM)) { '0000' } Else { $env:CIRCLE_BUILD_NUM }
 $RepoUrl = If ([System.String]::IsNullOrEmpty($env:CIRCLE_REPOSITORY_URL)) { 'https://github.com/TheJumpCloud/jcapi-powershell' } Else { $env:CIRCLE_REPOSITORY_URL }
@@ -119,7 +118,7 @@ ForEach ($SDK In $SDKName)
         {
             If (Test-Path -Path:($OutputFullPath)) { Get-ChildItem -Path:($OutputFullPath) | Where-Object { $_.Name -notin $FolderExcludeList } | Remove-Item -Force -Recurse }
             If (!(Test-Path -Path:($OutputFullPath))) { New-Item -Path:($OutputFullPath) -ItemType:('Directory') }
-            if ($IsMacOS)
+            if ($IsMacOS -or $IsLinux)
             {
                 Write-Host ('[RUN COMMAND] Clean Script') -BackgroundColor:('Black') -ForegroundColor:('Magenta')
                 # check if the /bin /obj directories need to permissions reset and deleted before continuing.
@@ -152,7 +151,7 @@ ForEach ($SDK In $SDKName)
             $BuildModuleContent = Get-Content -Path:($buildModulePath) -Raw
             $BuildModuleContent.Replace('Export-ExampleStub -ExportsFolder', '#Export-ExampleStub -ExportsFolder') | Set-Content -Path:($buildModulePath)
             $BuildModuleCommand = "$buildModulePath -Release"
-            if ($IsMacOS)
+            if ($IsMacOS -or $IsLinux)
             {
                 Write-Host ('[RUN COMMAND] Clean Script') -BackgroundColor:('Black') -ForegroundColor:('Magenta')
                 bash $CleanScript $PSScriptRoot $OutputFullPath
@@ -193,7 +192,7 @@ ForEach ($SDK In $SDKName)
                     $BuildModuleContent.Replace('#Export-ExampleStub -ExportsFolder', 'Export-ExampleStub -ExportsFolder') | Set-Content -Path:($buildModulePath)
                     # Build-module
                     $BuildModuleCommand = "$buildModulePath -Docs -Release"
-                    if ($IsMacOS)
+                    if ($IsMacOS -or $IsLinux)
                     {
                         Write-Host ('[RUN COMMAND] Clean Script') -BackgroundColor:('Black') -ForegroundColor:('Magenta')
                         bash $CleanScript $PSScriptRoot $OutputFullPath
@@ -246,7 +245,7 @@ ForEach ($SDK In $SDKName)
                     If (-not [System.String]::IsNullOrEmpty($UnusedTestFiles)) { $UnusedTestFiles | Remove-Item -Force -Recurse }
                     # Rebuild to distribute the update PSScriptInfo to other locations
                     $BuildModuleCommand = "$buildModulePath -Docs -Release"
-                    if ($IsMacOS)
+                    if ($IsMacOS -or $IsLinux)
                     {
                         Write-Host ('[RUN COMMAND] Clean Script') -BackgroundColor:('Black') -ForegroundColor:('Magenta')
                         bash $CleanScript $PSScriptRoot $OutputFullPath
@@ -291,7 +290,7 @@ ForEach ($SDK In $SDKName)
         # Remove auto generated .gitignore files
         If ($ModifyGitIgnore)
         {
-            $GitIgnoreFiles = Get-ChildItem -Path:($OutputFullPath) -Recurse -File | Where-Object { $_.Extension -eq '.gitignore' }
+            $GitIgnoreFiles = Get-ChildItem -Path:($OutputFullPath) -Recurse -File -Hidden | Where-Object { $_.Extension -eq '.gitignore' }
             $GitIgnoreFiles | ForEach-Object {
                 $GitIgnoreContent = Get-Content -Path:($_.FullName) -Raw
                 $GitIgnoreContent = $GitIgnoreContent.Replace('exports', "exports`n!docs/exports")

Configs/JumpCloud.SDK.DirectoryInsights.yaml

@@ -33,12 +33,12 @@ input-file:
 module-name: JumpCloud.SDK.DirectoryInsights
 namespace: JumpCloud.SDK.DirectoryInsights
 sample-generation: true
-module-version: 0.0.23
+module-version: 0.0.24
 dll-name: JumpCloud.SDK.DirectoryInsights.private
 
 directive:
   - where:
       prefix: JcSdk
     hide: true
 # Prevent response flattening: https://github.com/Azure/autorest.powershell/issues/743
-# inlining-threshold: 0
+# inlining-threshold: 0

Configs/JumpCloud.SDK.V1.yaml

@@ -33,7 +33,7 @@ input-file:
 module-name: JumpCloud.SDK.V1
 namespace: JumpCloud.SDK.V1
 sample-generation: true
-module-version: 0.0.35
+module-version: 0.0.36
 dll-name: JumpCloud.SDK.V1.private
 
 directive:

Configs/JumpCloud.SDK.V2.yaml

@@ -33,12 +33,12 @@ input-file:
 module-name: JumpCloud.SDK.V2
 namespace: JumpCloud.SDK.V2
 sample-generation: true
-module-version: 0.0.39
+module-version: 0.0.40
 dll-name: JumpCloud.SDK.V2.private
 
 directive:
   - where:
       prefix: JcSdk
     hide: true
 # Prevent response flattening: https://github.com/Azure/autorest.powershell/issues/743
-# inlining-threshold: 0
+# inlining-threshold: 0

JumpCloud.SDK.DirectoryInsights.md

@@ -1,3 +1,35 @@
+## JumpCloud.SDK.DirectoryInsights-0.0.24
+Release Date: November 14, 2023
+#### RELEASE NOTES
+```
+This is a rollup release for the DI module, no functional changes were made
+```
+#### FEATURES:
+NA
+#### IMPROVEMENTS:
+NA
+#### BUG FIXES:
+NA
+#### Generated Changes:
+
+<details>
+<summary>Functions Added</summary>
+
+No changes
+</details>
+
+<details>
+<summary>Functions Modified</summary>
+
+No changes
+</details>
+
+<details>
+<summary>Functions Removed</summary>
+
+No changes
+</details>
+
 ## JumpCloud.SDK.DirectoryInsights-0.0.23
 Release Date: June 07, 2023
 #### RELEASE NOTES

JumpCloud.SDK.V1.md

@@ -1,3 +1,39 @@
+## JumpCloud.SDK.V1-0.0.36
+Release Date: November 14, 2023
+#### RELEASE NOTES
+```
+This release includes a new funcion `Start-JCSdkCommand` which can be used to ad-hoc invoke commands on a list of systems
+```
+#### FEATURES:
+NA
+#### IMPROVEMENTS:
+NA
+#### BUG FIXES:
+NA
+#### Generated Changes:
+
+<details>
+<summary>Functions Added</summary>
+
+* Start-JcSdkCommand.ps1
+
+</details>
+
+<details>
+<summary>Functions Modified</summary>
+
+* New-JcSdkApplication.ps1
+* Set-JcSdkAdministratorUser.ps1
+* Set-JcSdkApplication.ps1
+
+</details>
+
+<details>
+<summary>Functions Removed</summary>
+
+No changes
+</details>
+
 ## JumpCloud.SDK.V1-0.0.35
 Release Date: June 07, 2023
 #### RELEASE NOTES

JumpCloud.SDK.V2.md

@@ -1,3 +1,46 @@
+## JumpCloud.SDK.V2-0.0.40
+Release Date: November 14, 2023
+#### RELEASE NOTES
+```
+This is a rollup release for the DI module, no functional changes were made
+```
+#### FEATURES:
+NA
+#### IMPROVEMENTS:
+NA
+#### BUG FIXES:
+NA
+#### Generated Changes:
+
+<details>
+<summary>Functions Added</summary>
+
+No changes
+</details>
+
+<details>
+<summary>Functions Modified</summary>
+
+* Get-JcSdkAppleMdm.ps1
+* Get-JcSdkProvidersInvoice.ps1
+* New-JcSdkProviderAdministrator.ps1
+* New-JcSdkSoftwareApp.ps1
+* New-JcSdkSystemGroup.ps1
+* New-JcSdkUserGroup.ps1
+* Set-JcSdkSoftwareApp.ps1
+* Set-JcSdkSystemGroup.ps1
+* Set-JcSdkUserGroup.ps1
+* Update-JcSdkGSuite.ps1
+
+</details>
+
+<details>
+<summary>Functions Removed</summary>
+
+* Get-JcSdkGsuiteUsersToImportFormated.ps1
+
+</details>
+
 ## JumpCloud.SDK.V2-0.0.39
 Release Date: June 07, 2023
 #### RELEASE NOTES