class in UnityEditor.PackageManager
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseInformation containing the result of a package packing operation. This information includes the path to the generated tarball file.
Notes:
PackOperationResult
is the result of Client.Pack operations.using UnityEditor; using UnityEditor.PackageManager; using UnityEngine; using UnityEditor.PackageManager.Requests;
public class PackagePackerExample : EditorWindow { [MenuItem("Window/Package Packer")] public static void ShowWindow() { GetWindow<PackagePackerExample>("Package Packer"); }
string m_PackageFolder = ""; string m_OutputFolder = ""; PackRequest m_PackRequest;
void OnGUI() { GUILayout.Label("Package Packer", EditorStyles.boldLabel);
// Package folder selection EditorGUILayout.BeginHorizontal(); m_PackageFolder = EditorGUILayout.TextField("Package Folder", m_PackageFolder); if (GUILayout.Button("Browse", GUILayout.Width(60))) { m_PackageFolder = EditorUtility.OpenFolderPanel("Select Package Folder", "", ""); } EditorGUILayout.EndHorizontal();
// Output folder selection EditorGUILayout.BeginHorizontal(); m_OutputFolder = EditorGUILayout.TextField("Output Folder", m_OutputFolder); if (GUILayout.Button("Browse", GUILayout.Width(60))) { m_OutputFolder = EditorUtility.OpenFolderPanel("Select Output Folder", "", ""); } EditorGUILayout.EndHorizontal();
if (GUILayout.Button("Pack Package")) { // Validating paths is good practice, but skipped in this example PackPackage(); } }
void PackPackage() { EditorUtility.DisplayProgressBar("Package Packer", "Creating package tarball...", 0.5f);
m_PackRequest = Client.Pack(m_PackageFolder, m_OutputFolder); EditorApplication.update += TrackPackOperationProgress; }
void TrackPackOperationProgress() { try { if (m_PackRequest.IsCompleted) { EditorApplication.update -= TrackPackOperationProgress; EditorUtility.ClearProgressBar();
if (m_PackRequest.Status == StatusCode.Success) { // The Result property on the next line is the PackOperationResult var tarballPath = m_PackRequest.Result.tarballPath; Debug.Log($"Package created successfully at: {tarballPath}");
// Show in file browser EditorUtility.RevealInFinder(tarballPath); } else { Debug.LogError($"Failed to create package: {m_PackRequest.Error.message}"); } } } catch { Debug.LogError("Pack operation failed."); EditorApplication.update -= TrackPackOperationProgress; } } }
Related information
tarballPath | The path to the file created by the Client.Pack operation. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.