Pack
Creates a GZip tarball file from a package folder. The format and content of the file is the same as if the package was published to a package registry.
Read time 3 minutesLast updated 12 days ago
Definition
- Type: Method
- Namespace: UnityEditor.PackageManager
- Assembly: UnityEditor.CoreModule
Pack(string, string)
Creates a GZip tarball file from a package folder. The format and content of the file is the same as if the package was published to a package registry.
Warning
Deprecated. Pack(string, string) is deprecated and will be removed in a later version. Use Pack(string, string, string) instead.
public static PackRequest Pack(string packageFolder, string targetFolder)
Parameters
Folder containing the package. is thrown if is , empty, or whitespace.
ArgumentExceptionpackageFoldernullFolder where the Package Manager will write the GZip tarball file. The Package Manager will create this folder if it doesn't exist. is thrown if is , empty, or whitespace.
ArgumentExceptiontargetFoldernullReturns
Type | Description |
|---|---|
| PackRequest | A PackRequest instance, which you can use to get the PackOperationResult representing the path of the generated tarball from the |
Remarks
Pack()PackRequestNote: Make sure any other Client operations have completed before calling this method. For more information, refer to the note on the Client class reference page.
Examples
using UnityEngine;using UnityEditor.PackageManager;using UnityEditor.PackageManager.Requests;[ExecuteInEditMode]public class PackageManagerClientPackExample : MonoBehaviour{ PackRequest m_PackRequest; void Start() { Debug.Log("Client.Pack example..."); // Replace with your actual package folder, target output folder, and organization ID string packageFolder = "Packages/com.company.mypackage"; string targetFolder = "Builds"; string ownerOrgId = "1234567"; m_PackRequest = Client.Pack(packageFolder, targetFolder, ownerOrgId); } void Update() { if (m_PackRequest != null && m_PackRequest.IsCompleted) { if (m_PackRequest.Status == StatusCode.Success) { Debug.Log($"Package successfully packed at: {m_PackRequest.Result.tarballPath}"); } else { Debug.LogError($"Pack failed: {m_PackRequest.Error.message}"); } m_PackRequest = null; } }}
Pack(string, string, string)
Creates a GZip tarball file from a package folder. The format and content of the file is the same as if the package was published to a package registry.
public static PackRequest Pack(string packageFolder, string targetFolder, string ownerOrgId)
Parameters
Folder containing the package. is thrown if is , empty, or whitespace.
ArgumentExceptionpackageFoldernullFolder where the Package Manager will write the GZip tarball file. The Package Manager will create this folder if it doesn't exist. is thrown if is , empty, or whitespace.
ArgumentExceptiontargetFoldernullThe ID of the organization that owns the package. is thrown if is , empty, or whitespace.
ArgumentExceptionownerOrgIdnullReturns
Type | Description |
|---|---|
| PackRequest | A PackRequest instance, which you can use to get the PackOperationResult representing the path of the generated tarball from the |
Remarks
Pack()PackRequestNote: Make sure any other Client operations have completed before calling this method. For more information, refer to the note on the Client class reference page.
Examples
using UnityEngine;using UnityEditor.PackageManager;using UnityEditor.PackageManager.Requests;[ExecuteInEditMode]public class PackageManagerClientPackExample : MonoBehaviour{ PackRequest m_PackRequest; void Start() { Debug.Log("Client.Pack example..."); // Replace with your actual package folder, target output folder, and organization ID string packageFolder = "Packages/com.company.mypackage"; string targetFolder = "Builds"; string ownerOrgId = "1234567"; m_PackRequest = Client.Pack(packageFolder, targetFolder, ownerOrgId); } void Update() { if (m_PackRequest != null && m_PackRequest.IsCompleted) { if (m_PackRequest.Status == StatusCode.Success) { Debug.Log($"Package successfully packed at: {m_PackRequest.Result.tarballPath}"); } else { Debug.LogError($"Pack failed: {m_PackRequest.Error.message}"); } m_PackRequest = null; } }}