Add Proxy Module, Setup Pipeline, Fix Project Dependency to NetStandard2.0 #42
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "instanceUrl": "https://msazure.visualstudio.com", | ||
| "projectName": "One", | ||
| "areaPath": "One\\MGMT\\Compute\\Powershell\\Powershell\\PowerShell Core\\ThreadJob", | ||
| "codebaseName": "TFSMSAzure_ThreadJob", | ||
| "notificationAliases": [ "[email protected]", "[email protected]" ], | ||
| "tools": [ "CredScan", "PoliCheck", "BinSkim" ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| version: 2 | ||
| updates: | ||
| - package-ecosystem: "nuget" # See documentation for possible values | ||
| directory: "/src/code" # Location of package manifests | ||
| schedule: | ||
| interval: "daily" | ||
|
|
||
| - package-ecosystem: github-actions | ||
| directory: / | ||
| schedule: | ||
| interval: daily | ||
|
|
||
| - package-ecosystem: nuget | ||
| directory: / | ||
| schedule: | ||
| interval: daily | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,248 @@ | ||||||
| name: ThreadJob-ModuleBuild-$(Build.BuildId) | ||||||
| trigger: none | ||||||
| pr: none | ||||||
|
|
||||||
| schedules: | ||||||
| - cron: '0 3 * * 1' | ||||||
| displayName: Weekly Build | ||||||
| branches: | ||||||
| include: | ||||||
| - onebranch-pipelines | ||||||
| always: true | ||||||
|
|
||||||
| parameters: | ||||||
| - name: 'publishOfficialToPowerShellGallery' | ||||||
| displayName: 'Publish official module to PowerShell gallery' | ||||||
| type: boolean | ||||||
| default: false | ||||||
| - name : 'publishProxyToPowerShellGallery' | ||||||
| displayName: 'Publish proxy module to PowerShell gallery' | ||||||
| type: boolean | ||||||
| default: false | ||||||
|
|
||||||
| variables: | ||||||
| BuildConfiguration: Release | ||||||
| DOTNET_NOLOGO: true | ||||||
| DOTNET_GENERATE_ASPNET_CERTIFICATE: false | ||||||
| DOTNET_CLI_TELEMETRY_OPTOUT: 1 | ||||||
| POWERSHELL_TELEMETRY_OPTOUT: 1 | ||||||
| DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1 | ||||||
| WindowsContainerImage: onebranch.azurecr.io/windows/ltsc2022/vse2022:latest | ||||||
|
|
||||||
| resources: | ||||||
| repositories: | ||||||
| - repository: templates | ||||||
| type: git | ||||||
| name: OneBranch.Pipelines/GovernedTemplates | ||||||
| ref: refs/heads/main | ||||||
|
|
||||||
| extends: | ||||||
| # https://aka.ms/obpipelines/templates | ||||||
| template: v2/OneBranch.Official.CrossPlat.yml@templates | ||||||
| parameters: | ||||||
| release: | ||||||
| category: NonAzure | ||||||
| featureFlags: | ||||||
| WindowsHostVersion: | ||||||
| Version: 2022 | ||||||
| Network: Netlock | ||||||
| globalSdl: # https://aka.ms/obpipelines/sdl | ||||||
| asyncSdl: | ||||||
| enabled: true | ||||||
| forStages: [build] | ||||||
| #credscan: | ||||||
| # enabled: true | ||||||
| # scanfolder: $(Build.SourcesDirectory) | ||||||
| # suppressionsFile: $(Build.SourcesDirectory)\.config\suppress.json | ||||||
| stages: | ||||||
| - stage: build | ||||||
| jobs: | ||||||
| - job: main | ||||||
| displayName: Build package | ||||||
| pool: | ||||||
| type: windows | ||||||
| variables: | ||||||
| - name: ob_outputDirectory | ||||||
| value: $(Build.SourcesDirectory)/out | ||||||
| #- name: ob_sdl_credscan_suppressionsFile | ||||||
| # value: $(Build.SourcesDirectory)\.config\suppress.json | ||||||
| steps: | ||||||
| - pwsh: | | ||||||
| Write-Verbose -Verbose ((Get-Item $(Build.SourcesDirectory)).FullName) | ||||||
|
There was a problem hiding this comment. Wouldn't |
||||||
| Get-ChildItem $(Build.SourcesDirectory) -Recurse -File -Name | Write-Verbose -Verbose | ||||||
| $manifestData = Import-PowerShellDataFile -Path src/Microsoft.PowerShell.ThreadJob.psd1 | ||||||
| $moduleVersion = $manifestData.ModuleVersion | ||||||
| Write-Host "##vso[task.setvariable variable=version;isOutput=true]$moduleVersion" | ||||||
| if ($manifestData.PrivateData.PsData.Prerelease) { | ||||||
| $prerel = $manifestData.PrivateData.PSData.Prerelease | ||||||
| $nupkgVersion = "${moduleVersion}-${prerel}" | ||||||
| } else { | ||||||
| $nupkgVersion = $moduleVersion | ||||||
| } | ||||||
| Write-Host "##vso[task.setvariable variable=nupkgversion;isOutput=true]$nupkgVersion" | ||||||
|
There was a problem hiding this comment. I don't see There was a problem hiding this comment. This is a relic of the pipeline I copied. |
||||||
| name: package | ||||||
| displayName: Get version from project properties | ||||||
| - task: onebranch.pipeline.version@1 | ||||||
| displayName: Set OneBranch version | ||||||
| inputs: | ||||||
| system: Custom | ||||||
| customVersion: $(package.version) | ||||||
|
There was a problem hiding this comment. where does There was a problem hiding this comment. The following is in the pwsh task and sets version: $manifestData = Import-PowerShellDataFile -Path src/Microsoft.PowerShell.ThreadJob.psd1
$moduleVersion = $manifestData.ModuleVersion
Write-Host "##vso[task.setvariable variable=version;isOutput=true]$moduleVersion"Then the pwsh task is named package name: packageSo to access version, its using the task name as a prefix. |
||||||
| - task: UseDotNet@2 | ||||||
| displayName: Use .NET SDK | ||||||
| inputs: | ||||||
| packageType: sdk | ||||||
| useGlobalJson: true | ||||||
| - pwsh: | | ||||||
| Get-ChildItem | Write-Verbose -Verbose | ||||||
| Register-PSRepository -Name CFS -SourceLocation "https://pkgs.dev.azure.com/powershell/PowerShell/_packaging/powershell/nuget/v2" -InstallationPolicy Trusted | ||||||
| Install-Module -Repository CFS -Name Microsoft.PowerShell.PSResourceGet -MinimumVersion 1.0.5 | ||||||
| .\build.ps1 -clean -Build -BuildConfiguration Release -BuildFramework netstandard2.0 | ||||||
| displayName: Build | ||||||
| - task: onebranch.pipeline.signing@1 | ||||||
| displayName: Sign 1st-party files | ||||||
| inputs: | ||||||
| command: sign | ||||||
| signing_profile: external_distribution | ||||||
| search_root: $(Build.SourcesDirectory)/out | ||||||
| files_to_sign: | | ||||||
| **/*.psd1; | ||||||
| **/*.ps1xml; | ||||||
| **/*.psm1; | ||||||
| **/Microsoft.PowerShell.*.dll; | ||||||
| - task: ArchiveFiles@2 | ||||||
| displayName: Zip module | ||||||
| inputs: | ||||||
| rootFolderOrFile: $(Build.SourcesDirectory)/out/Microsoft.PowerShell.ThreadJob | ||||||
| includeRootFolder: false | ||||||
| archiveType: zip | ||||||
| archiveFile: out/Microsoft.PowerShell.ThreadJob-v$(package.version).zip | ||||||
| - task: ArchiveFiles@2 | ||||||
| displayName: Zip module | ||||||
| inputs: | ||||||
| rootFolderOrFile: $(Build.SourcesDirectory)/out/ThreadJob | ||||||
| includeRootFolder: false | ||||||
| archiveType: zip | ||||||
| archiveFile: out/ThreadJob-v$(package.version).zip | ||||||
|
There was a problem hiding this comment. Where does There was a problem hiding this comment. Origins of package.version answered above. Yes that is true! I need to update the versioning! Two different versionings in pipeline updated. |
||||||
| - pwsh: | | ||||||
| Get-ChildItem | Write-Verbose -Verbose | ||||||
| Write-Verbose -Verbose -Message "Install Microsoft.PowerShell.ThreadJob module" | ||||||
| Copy-Item -Path $(Build.SourcesDirectory)/out/Microsoft.PowerShell.ThreadJob -Destination ($env:PSModulePath -split ';')[0] -Recurse -Force | ||||||
| Write-Verbose -Verbose -Message "Test ThreadJob module manifest" | ||||||
| Test-ModuleManifest -Path $(Build.SourcesDirectory)/out/ThreadJob/ThreadJob.psd1 | ||||||
|
Comment on lines
+128
to
+131
There was a problem hiding this comment. Why do you need to install the There was a problem hiding this comment. This was a tricky situation. The proxy module ThreadJob.psd1 defines a dependency RequiredModules = @('Microsoft.PowerShell.ThreadJob')The build/signing (I forgot which one was throwing the error) required that Microsoft.PowerShell.ThreadJob is present on the machine. |
||||||
| .\build.ps1 -Publish | ||||||
| Write-Verbose -Verbose ((Get-Item .).FullName) | ||||||
| Write-Verbose -Verbose ((Get-Item $(Build.SourcesDirectory)).FullName) | ||||||
|
There was a problem hiding this comment. Same here, wouldn't |
||||||
| Get-ChildItem $(Build.SourcesDirectory) -Recurse -File -Name | Write-Verbose -Verbose | ||||||
| displayName: Package module | ||||||
| - task: onebranch.pipeline.signing@1 | ||||||
| displayName: Sign NuGet package | ||||||
| inputs: | ||||||
| command: sign | ||||||
| signing_profile: external_distribution | ||||||
| search_root: $(Build.SourcesDirectory) | ||||||
| files_to_sign: "**/*.nupkg" | ||||||
|
There was a problem hiding this comment. Does this signed |
||||||
| - stage: manual | ||||||
| dependsOn: build | ||||||
| jobs: | ||||||
| - job: validation | ||||||
| displayName: Manual validation | ||||||
| pool: | ||||||
| type: agentless | ||||||
| timeoutInMinutes: 1440 | ||||||
| steps: | ||||||
| - task: ManualValidation@0 | ||||||
| displayName: Wait 24 hours for validation | ||||||
| inputs: | ||||||
| notifyUsers: $(Build.RequestedForEmail) | ||||||
| instructions: Please validate the release and then publish it! | ||||||
| timeoutInMinutes: 1440 | ||||||
| - stage: release_official_MicrosoftPowerShellThreadJob_module | ||||||
| displayName: release official | ||||||
| variables: | ||||||
| ob_release_environment: PPE | ||||||
| drop: $(Pipeline.Workspace)/drop_build_main | ||||||
| version: $[ stageDependencies.build.main.outputs['package.version'] ] | ||||||
| dependsOn: [build, manual] | ||||||
| condition: ${{ parameters.publishOfficialToPowerShellGallery }} | ||||||
| jobs: | ||||||
| - job: publish | ||||||
| templateContext: | ||||||
| inputs: | ||||||
| - input: pipelineArtifact | ||||||
| artifactName: drop_build_main | ||||||
| displayName: Publish to PowerShell Gallery | ||||||
| pool: | ||||||
| type: release | ||||||
| os: linux | ||||||
| variables: | ||||||
| - group: ThreadJob_Gallery_API | ||||||
| steps: | ||||||
| - task: Bash@3 | ||||||
| inputs: | ||||||
| targetType: inline | ||||||
| script: | | ||||||
| sudo tdnf install -y powershell | ||||||
| displayName: Install PowerShell | ||||||
| - task: powershell@2 | ||||||
| inputs: | ||||||
| pwsh: true | ||||||
| targetType: inline | ||||||
| script: | | ||||||
| Write-Verbose -Verbose ((Get-Item $(Pipeline.Workspace)).FullName) | ||||||
| Get-ChildItem $(Pipeline.Workspace) -Recurse -File -Name | Write-Verbose -Verbose | ||||||
| Write-Verbose -Verbose -Message "Set up CFS repository" | ||||||
| Register-PSRepository -Name CFS -SourceLocation "https://pkgs.dev.azure.com/powershell/PowerShell/_packaging/powershell/nuget/v2" -InstallationPolicy Trusted -ErrorAction Continue | ||||||
| Write-Verbose -Verbose -Message "Install PSResourceGet module" | ||||||
| Install-Module -Repository CFS -Name Microsoft.PowerShell.PSResourceGet -MinimumVersion 1.0.5 -ErrorAction Continue -Force | ||||||
|
There was a problem hiding this comment. This runs on Linux, do you know the version of PowerShell installed? I guess it would be 7.4.x, and in that case the PSResourceGet module is in-box. There was a problem hiding this comment. Trying is find out if this is necessary |
||||||
| Write-Verbose -Verbose -Message "Publish module to PSGallery" | ||||||
| Publish-PSResource -ApiKey $env:GalleryPAT -Repository PSGallery -Path $(Pipeline.Workspace)/Microsoft.PowerShell.ThreadJob | ||||||
|
There was a problem hiding this comment. Maybe you don't need an env var?
Suggested change
There was a problem hiding this comment. Maybe? Do you think this needs to be changed? There was a problem hiding this comment. Please help me understand, if you call There was a problem hiding this comment. Looking into this and testing if Publish-PSResource will do the trick. |
||||||
| env: | ||||||
| GalleryPAT: $(ChungJustinAPIKey) | ||||||
| displayName: Publish to PowerShell Gallery | ||||||
| - stage: release_proxy_ThreadJob_module | ||||||
| displayName: release proxy | ||||||
| variables: | ||||||
| ob_release_environment: PPE | ||||||
| drop: $(Pipeline.Workspace)/drop_build_main | ||||||
| version: $[ stageDependencies.build.main.outputs['package.version'] ] | ||||||
| dependsOn: [build, manual] | ||||||
| condition: ${{ parameters.publishProxyToPowerShellGallery }} | ||||||
| jobs: | ||||||
| - job: publish | ||||||
| templateContext: | ||||||
| inputs: | ||||||
| - input: pipelineArtifact | ||||||
| artifactName: drop_build_main | ||||||
| displayName: Publish to PowerShell Gallery | ||||||
| pool: | ||||||
| type: release | ||||||
| os: linux | ||||||
| variables: | ||||||
| - group: ThreadJob_Gallery_API | ||||||
| steps: | ||||||
| - task: Bash@3 | ||||||
| inputs: | ||||||
| targetType: inline | ||||||
| script: | | ||||||
| sudo tdnf install -y powershell | ||||||
| displayName: Install PowerShell | ||||||
| - task: powershell@2 | ||||||
| inputs: | ||||||
| pwsh: true | ||||||
| targetType: inline | ||||||
| script: | | ||||||
| Write-Verbose -Verbose ((Get-Item $(Pipeline.Workspace)).FullName) | ||||||
| Get-ChildItem $(Pipeline.Workspace) -Recurse -File -Name | Write-Verbose -Verbose | ||||||
| Write-Verbose -Verbose -Message "Set up CFS repository" | ||||||
| Register-PSRepository -Name CFS -SourceLocation "https://pkgs.dev.azure.com/powershell/PowerShell/_packaging/powershell/nuget/v2" -InstallationPolicy Trusted -ErrorAction Continue | ||||||
| Write-Verbose -Verbose -Message "Install PSResourceGet module" | ||||||
| Install-Module -Repository CFS -Name Microsoft.PowerShell.PSResourceGet -MinimumVersion 1.0.5 -ErrorAction Continue -Force | ||||||
| Write-Verbose -Verbose -Message "Install Microsoft.PowerShell.ThreadJob module" | ||||||
| Copy-Item -Path $(Pipeline.Workspace)/Microsoft.PowerShell.ThreadJob -Destination ($env:PSModulePath -split ':')[0] -Recurse -Force -Verbose | ||||||
| Write-Verbose -Verbose -Message "Test ThreadJob module manifest" | ||||||
| Test-ModuleManifest -Path $(Pipeline.Workspace)/ThreadJob/ThreadJob.psd1 | ||||||
|
Comment on lines
+241
to
+243
There was a problem hiding this comment. Can you please help me understand why this testing is needed? There was a problem hiding this comment. That is to test and confirm the dependency in ThreadJob.psd1 and check that Microsoft.PowerShell.ThreadJob is installed on the machine. |
||||||
| Write-Verbose -Verbose -Message "Publish module to PSGallery" | ||||||
| Publish-PSResource -ApiKey $env:GalleryPAT -Repository PSGallery -Path $(Pipeline.Workspace)/ThreadJob | ||||||
| env: | ||||||
| GalleryPAT: $(ChungJustinAPIKey) | ||||||
| displayName: Publish to PowerShell Gallery | ||||||
|
|
||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nitpick: usually we leave a new line at the end of a file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done