The field Release Notes must be a string or array type with a maximum length of 10000

Unable to upload the package to Orchestrator, and encountering the following error: "The field 'Release Notes' must be a string or array type with a maximum length of 10,000."

Issue Description

When attempting to upload a package to Orchestrator, the following error is encountered:

"The field 'Release Notes' must be a string or array type with a maximum length of 10,000."

Root Cause

The issue occurs when the "release notes" metadata within the package exceeds the maximum character limit of 10,000 characters.

Resolution

  1. Extract the .nupkg File
    Use an extraction tool such as 7-Zip or any similar software to extract the .nupkg file. Once extracted, locate the file.nupesc within the extracted folder.

  1. Edit the .nupesc File

    • Open the .nupesc file in a text editor, such as Notepad++ or any equivalent tool.
    • Inside the file, you will find the release notes information related to the package.
    • Remove unnecessary details: Delete information regarding previous versions, retaining only the relevant details for the current version you are using.

  1. Repackage the Files

    • After editing the .nupesc file, compress the entire extracted folder into a .zip file.
    • Rename the compressed .zip file to a .nupkg file.
  2. Upload to Orchestrator

    • Once the .nupkg file is ready, proceed to upload the package to Orchestrator. The error should no longer occur.

Additional Notes

  • Ensure only relevant information is retained in the release notes to remain under the 10,000-character limit.
  • Making excessive edits to the release notes may result in loss of useful historical data. Consider keeping essential version history if needed.
  • Applies to:
    • Orchestrator Package Management
    • Users encountering metadata limit errors during package uploads.