Skip to content

Exclude authors from valid metadata check when uploading symbol package

Moaz Khalifa requested to merge 415045-Exclude-authors-from-valid-metadata-check-for-NuGet-symbol-packages into master

What does this MR do and why?

In !120100 (merged), we implemented a change that introduced two new required metadata properties, authors and description, for NuGet packages. As a result, we now enforce the presence of these properties in the uploaded metadata file before allowing the publishing of a new NuGet package.

However, this change overlooks a specific case concerning symbol packages (.snupkg). Symbol packages, as described in the Microsoft documentation on symbol package structure, do not include the authors property in their metadata files. Therefore, the current implementation prevents the publishing of symbol packages due to the absence of the authors metadata property.

To address this issue, we need to modify the implementation to allow the publishing of symbol packages without enforcing the presence of the authors metadata property. This adjustment will ensure that symbol packages can be published successfully without any unnecessary validation errors.

Screenshots or screen recordings

Screenshot_2023-06-12_at_12.14.12

How to set up and validate locally

  1. Follow the steps outlined in the Microsoft documentation on creating a symbol package to create a new symbol package.
  2. Attempt to push the symbol package to your GDK using the documentation on publishing symbol packages to a NuGet repository.
  3. Access your GDK user interface (UI) and navigate the project's Package Registry page.
  4. Locate the symbol package that was pushed in Step 2.
  5. The package should have been successfully published.
  6. Switch to the master branch and try to push the package again. You should find an error message displayed indicating the failure of publishing the symbol package, with the specific error message being Invalid Package: failed metadata extraction.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Related to #415045 (closed)

Edited by Moaz Khalifa

Merge request reports