-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Create a packaging pipeline for a custom nuget package #23918
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
142 changes: 142 additions & 0 deletions
142
tools/ci_build/github/azure-pipelines/custom-nuget-packaging-pipeline.yml
This file contains hidden or 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,142 @@ | ||
| parameters: | ||
| - name: CudaVersion | ||
| type: string | ||
| default: '12.2' | ||
|
|
||
| - name: QnnSdk | ||
| displayName: QNN SDK Version | ||
| type: string | ||
| default: 2.31.0.250130 | ||
|
|
||
| - name: IsReleaseBuild | ||
| displayName: Is a release build? Set it to true if you are doing an Onnx Runtime release. | ||
| type: boolean | ||
| default: false | ||
|
|
||
| - name: PackageName | ||
| displayName: What is the package name? | ||
| type: string | ||
| default: 'Microsoft.ML.OnnxRuntime.Flamingo' | ||
|
|
||
| variables: | ||
| - template: templates/common-variables.yml | ||
| - name: ReleaseVersionSuffix | ||
| value: '' | ||
| - name: win_cuda_home | ||
| ${{ if eq(parameters.CudaVersion, '11.8') }}: | ||
| value: $(Agent.TempDirectory)\v11.8 | ||
| ${{ if eq(parameters.CudaVersion, '12.2') }}: | ||
| value: $(Agent.TempDirectory)\v12.2 | ||
|
|
||
| stages: | ||
| - template: templates/win-ci.yml | ||
| parameters: | ||
| ort_build_pool_name: 'onnxruntime-Win2022-GPU-A10' | ||
| DoCompliance: false | ||
| DoEsrp: true | ||
| stage_name_suffix: CUDA | ||
| buildArch: x64 | ||
| msbuildPlatform: x64 | ||
| packageName: x64-cuda | ||
| CudaVersion: ${{ parameters.CudaVersion }} | ||
| buildparameter: --use_cuda --cuda_home=${{ variables.win_cuda_home }} --enable_onnx_tests --enable_wcos --use_webgpu --cmake_extra_defines "CMAKE_CUDA_ARCHITECTURES=52-real;61-real;75-real;86-real;89-real;90-virtual" | ||
| runTests: false | ||
| buildJava: false | ||
| java_artifact_id: onnxruntime_gpu | ||
| UseIncreasedTimeoutForTests: false | ||
| SpecificArtifact: false | ||
| BuildId: '0' | ||
|
|
||
| - template: templates/qnn-ep-win.yml | ||
| parameters: | ||
| qnn_ep_build_pool_name: 'Onnxruntime-QNNEP-Windows-2022-CPU' | ||
| QnnSdk: ${{ parameters.QnnSdk }} | ||
| IsReleaseBuild: ${{ parameters.IsReleaseBuild }} | ||
| DoEsrp: true | ||
| ArtifactName: 'drop-nuget-qnn-arm64' | ||
| # Add --use_webgpu to enable WebGPU | ||
| buildParameter: '--arm64' | ||
| buildPlatform: 'ARM64' | ||
| buildArch: 'ARM64' | ||
| StageName: 'OnnxRuntime_QNN_Nuget_Win_Arm64' | ||
| build_config: 'RelWithDebInfo' | ||
| Is1ES: false | ||
| PublishArchive: true | ||
|
|
||
| - stage: NugetPackaging | ||
| dependsOn: [Windows_Packaging_CUDA, OnnxRuntime_QNN_Nuget_Win_Arm64] | ||
| jobs: | ||
| - job: CreateNugetPackage | ||
| pool: 'Onnxruntime-Win2022-GPU-A10' | ||
| timeoutInMinutes: 120 | ||
| steps: | ||
| - checkout: self | ||
| clean: true | ||
| submodules: none | ||
|
|
||
| - task: UsePythonVersion@0 | ||
| inputs: | ||
| versionSpec: '3.12' | ||
| addToPath: true | ||
|
|
||
| - task: DownloadPipelineArtifact@0 | ||
| displayName: 'Download Pipeline Artifact - managed nuget' | ||
| inputs: | ||
| artifactName: 'drop-nuget-qnn-arm64' | ||
| targetPath: '$(Build.BinariesDirectory)/managed-nuget' | ||
|
|
||
| - task: DownloadPipelineArtifact@0 | ||
| displayName: 'Download Pipeline Artifact - win-x64' | ||
| inputs: | ||
| artifactName: 'onnxruntime-win-x64-cuda' | ||
| targetPath: '$(Build.BinariesDirectory)/win-x64' | ||
|
|
||
| - task: DownloadPipelineArtifact@0 | ||
| displayName: 'Download Pipeline Artifact - win-arm64' | ||
| inputs: | ||
| artifactName: 'onnxruntime-win-ARM64-qnn' | ||
| targetPath: '$(Build.BinariesDirectory)/win-arm64' | ||
|
|
||
| - task: PowerShell@2 | ||
| displayName: 'Extract Nuget Package Version' | ||
| inputs: | ||
| targetType: 'inline' | ||
| script: | | ||
| $nupkgs = (Get-ChildItem $(Build.BinariesDirectory)/managed-nuget -Filter Microsoft.ML.OnnxRuntime.Managed.*.nupkg -Recurse) | ||
| $package_name = $nupkgs[0].Name | ||
| $version_length = $package_name.Length - "Microsoft.ML.OnnxRuntime.Managed.".Length - ".nupkg".Length | ||
| $package_version = $package_name.Substring("Microsoft.ML.OnnxRuntime.Managed.".Length, $version_length) | ||
| Write-Host "##vso[task.setvariable variable=package_version;]$package_version" | ||
| workingDirectory: $(Build.BinariesDirectory) | ||
|
|
||
| - task: PowerShell@2 | ||
| displayName: 'Extract Archives' | ||
| inputs: | ||
| targetType: 'inline' | ||
| script: | | ||
| Expand-Archive -Path $(Build.BinariesDirectory)/win-x64/onnxruntime-win-x64-cuda*.zip -DestinationPath $(Build.BinariesDirectory)/win-x64 | ||
| Expand-Archive -Path $(Build.BinariesDirectory)/win-arm64/onnxruntime-win-ARM64-qnn*.zip -DestinationPath $(Build.BinariesDirectory)/win-arm64 | ||
| $win_x64 = (Get-ChildItem -Path $(Build.BinariesDirectory)/win-x64 -Filter onnxruntime-win-x64-cuda*)[0].FullName | ||
| $win_arm64 = (Get-ChildItem -Path $(Build.BinariesDirectory)/win-arm64 -Filter onnxruntime-win-ARM64-qnn*)[0].FullName | ||
| Write-Host "##vso[task.setvariable variable=win_x64;]$win_x64" | ||
| Write-Host "##vso[task.setvariable variable=win_arm64;]$win_arm64" | ||
| workingDirectory: $(Build.BinariesDirectory) | ||
|
|
||
| - task: PythonScript@0 | ||
| displayName: 'Generate Nuget Package' | ||
| inputs: | ||
| scriptPath: '$(Build.SourcesDirectory)/tools/nuget/generate_nuspec_for_custom_nuget.py' | ||
| arguments: '--nuspec_path "$(Build.BinariesDirectory)/${{ parameters.PackageName }}.nuspec" --root_dir "$(Build.SourcesDirectory)" --commit_id "$(Build.SourceVersion)" --win_arm64 "$(win_arm64)" --win_x64 "$(win_x64)" --package_version "$(package_version)" --package_name "${{ parameters.PackageName }}"' | ||
|
|
||
| - task: NuGetCommand@2 | ||
| displayName: 'Pack Nuget Package' | ||
| inputs: | ||
| command: 'pack' | ||
| packagesToPack: '$(Build.BinariesDirectory)/${{ parameters.PackageName }}.nuspec' | ||
| packDestination: $(Build.ArtifactStagingDirectory)\ | ||
|
|
||
| - task: PublishBuildArtifacts@1 | ||
| displayName: 'Publish Artifact: Nuget' | ||
| inputs: | ||
| pathtoPublish: '$(Build.ArtifactStagingDirectory)' | ||
| artifactName: '${{ parameters.PackageName }}' |
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,150 @@ | ||
| # Copyright (c) Microsoft Corporation. All rights reserved. | ||
|
||
| # Licensed under the MIT License. | ||
|
|
||
| import argparse | ||
|
||
| import glob | ||
| import os | ||
| import shutil | ||
|
|
||
| from generate_nuspec_for_native_nuget import generate_metadata | ||
|
|
||
|
|
||
| def generate_files(lines, args): | ||
| files_list = ["<files>"] | ||
| platform_map = { | ||
| "win-arm64": args.win_arm64, | ||
| "win-x64": args.win_x64, | ||
| } | ||
|
|
||
| avoid_keywords = {"pdb"} | ||
| processed_includes = set() | ||
| for platform, platform_dir in platform_map.items(): | ||
| for file in glob.glob(os.path.join(platform_dir, "lib", "*")): | ||
| if not os.path.isfile(file): | ||
| continue | ||
| if any(keyword in file for keyword in avoid_keywords): | ||
| continue | ||
| file_name = os.path.basename(file) | ||
|
|
||
| files_list.append(f'<file src="{file}" target="runtimes/{platform}/native/{file_name}" />') | ||
|
|
||
| for file in glob.glob(os.path.join(platform_dir, "include", "*")): | ||
| if not os.path.isfile(file): | ||
| continue | ||
| file_name = os.path.basename(file) | ||
| if file_name in processed_includes: | ||
| continue | ||
| processed_includes.add(file_name) | ||
| files_list.append(f'<file src="{file}" target="build/native/include/{file_name}" />') | ||
|
|
||
| files_list.append( | ||
| f'<file src="{os.path.join(args.root_dir, "tools", "nuget", "nupkg.README.md")}" target="README.md" />' | ||
| ) | ||
|
|
||
| files_list.append(f'<file src="{os.path.join(args.root_dir, "LICENSE")}" target="LICENSE" />') | ||
| files_list.append( | ||
| f'<file src="{os.path.join(args.root_dir, "ThirdPartyNotices.txt")}" target="ThirdPartyNotices.txt" />' | ||
| ) | ||
| files_list.append(f'<file src="{os.path.join(args.root_dir, "docs", "Privacy.md")}" target="Privacy.md" />') | ||
| files_list.append( | ||
| f'<file src="{os.path.join(args.root_dir, "ORT_icon_for_light_bg.png")}" target="ORT_icon_for_light_bg.png" />' | ||
| ) | ||
|
|
||
| source_props = os.path.join( | ||
| args.root_dir, | ||
| "csharp", | ||
| "src", | ||
| "Microsoft.ML.OnnxRuntime", | ||
| "targets", | ||
| "netstandard", | ||
| "props.xml", | ||
| ) | ||
| target_props = os.path.join( | ||
| args.root_dir, | ||
| "csharp", | ||
| "src", | ||
| "Microsoft.ML.OnnxRuntime", | ||
| "targets", | ||
| "netstandard", | ||
| f"{args.package_name}.props", | ||
| ) | ||
| shutil.copyfile(source_props, target_props) | ||
| files_list.append(f'<file src="{target_props}" target="build/netstandard2.0/" />') | ||
| files_list.append(f'<file src="{target_props}" target="build/netstandard2.1/" />') | ||
|
|
||
| source_targets = os.path.join( | ||
| args.root_dir, | ||
| "csharp", | ||
| "src", | ||
| "Microsoft.ML.OnnxRuntime", | ||
| "targets", | ||
| "netstandard", | ||
| "targets.xml", | ||
| ) | ||
| target_targets = os.path.join( | ||
| args.root_dir, | ||
| "csharp", | ||
| "src", | ||
| "Microsoft.ML.OnnxRuntime", | ||
| "targets", | ||
| "netstandard", | ||
| f"{args.package_name}.targets", | ||
| ) | ||
| shutil.copyfile(source_targets, target_targets) | ||
| files_list.append(f'<file src="{target_targets}" target="build/netstandard2.0/" />') | ||
| files_list.append(f'<file src="{target_targets}" target="build/netstandard2.1/" />') | ||
|
|
||
| files_list.append("</files>") | ||
| lines.extend(files_list) | ||
|
|
||
|
|
||
| def parse_arguments(): | ||
| parser = argparse.ArgumentParser( | ||
| description="Create a nuspec file for the custom nuget package.", | ||
| ) | ||
|
|
||
| parser.add_argument("--nuspec_path", required=True, help="Nuspec output file path.") | ||
| parser.add_argument("--root_dir", required=True, help="ORT repository root.") | ||
| parser.add_argument( | ||
| "--commit_id", | ||
| required=True, | ||
| help="The last commit id included in this package.", | ||
| ) | ||
| parser.add_argument("--win_arm64", required=True, help="Ort win-arm64 directory") | ||
| parser.add_argument("--win_x64", required=True, help="Ort win-x64 directory") | ||
| parser.add_argument("--package_version", required=True, help="Version of the package") | ||
| parser.add_argument("--package_name", required=True, help="Name of the package") | ||
|
|
||
| args = parser.parse_args() | ||
|
|
||
| args.sdk_info = "" | ||
|
|
||
| return args | ||
|
|
||
|
|
||
| def generate_nuspec(args: argparse.Namespace): | ||
| lines = ['<?xml version="1.0"?>'] | ||
| lines.append("<package>") | ||
|
|
||
| generate_metadata(lines, args) | ||
| generate_files(lines, args) | ||
|
|
||
| lines.append("</package>") | ||
| return lines | ||
|
|
||
|
|
||
| def main(): | ||
| args = parse_arguments() | ||
|
|
||
| lines = generate_nuspec(args) | ||
|
|
||
| with open(os.path.join(args.nuspec_path), "w") as f: | ||
| for line in lines: | ||
| # Uncomment the printing of the line if you need to debug what's produced on a CI machine | ||
| print(line) | ||
| f.write(line) | ||
| f.write("\n") | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| main() | ||
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.
Uh oh!
There was an error while loading. Please reload this page.