Testing PnP Modern Search Versions Safely with Site Collection App Catalogs

When working with PnP Modern Search, testing new versions can be risky if done directly in the tenant app catalog. Any issues or bugs might affect all sites using the app, leading to downtime or unexpected behavior. A safer approach is to use a site collection app catalog. This method isolates testing to a single site collection, allowing you to try new versions without impacting the entire tenant.

This post explains how to set up and use a site collection app catalog for testing PnP Modern Search versions safely. You will learn why this approach matters, how to configure it, and practical tips to avoid common pitfalls.

Why Use a Site Collection App Catalog for Testing?

The tenant app catalog is a centralized location where SharePoint apps are deployed for use across the entire tenant. While convenient, it carries risks:

• Tenant-wide impact: Any app update affects all sites using that app.

• Limited rollback options: Reverting changes can be complex and disruptive.

• Potential downtime: Bugs or errors in new versions can cause service interruptions.

  
  

By contrast, a site collection app catalog lets you:

• Test in isolation: Only the specific site collection uses the new app version.

• Control deployment scope: You decide exactly where the app is available.

• Reduce risk: Problems stay contained and do not affect other sites.

  
  

This approach is especially useful for PnP Modern Search, which often receives updates and new features. Testing in a controlled environment helps ensure stability before tenant-wide rollout.

Uploading the PnP Modern Search package to the site collection app catalog

How to Set Up a Site Collection App Catalog

Setting up a site collection app catalog requires some PowerShell commands and SharePoint admin permissions. Here’s a step-by-step guide:

1. Enable site collection app catalog feature

   
   

   Use the SharePoint Online Management Shell and run:

   
   

```powershell

$adminUrl = "the Url of your SharePoint Admin center"
$siteUrl = "the Url of the site"
$PnPClientId = "the id of the PnP App in your tenant"
$adminConnection = Connect-PnPOnline -Url $adminUrl -Interactive -ClientId $PnPClientId -ReturnConnection
Add-PnPSiteCollectionAppCatalog -Site $siteUrl -Connection $AdminConnection | Out-Null

```

Replace the URLs with your tenant and site collection URLs.

1. Upload the PnP Modern Search app package

   
   

   Download the latest PnP Modern Search `.sppkg` file from the official repository. Then:

   
   

2. Go to the site collection’s app catalog site (usually at `/sites/yoursite/AppCatalog`).

3. Upload the `.sppkg` file to the Apps for SharePoint library.

4. When prompted, choose to deploy the app only to this site collection.

   
   

5. Add the app to your site

   
   

6. Navigate to your site collection.

7. Go to Site Contents > Add an app.

8. Find the PnP Modern Search app and add it.

   
   

9. Test the new version

   
   

Use the app in this site collection to verify new features or fixes. Since the app is scoped to this site, other sites remain unaffected.

If you are not sure that you are using the new version, each of the web parts will show the version number on the last configuration page, like this:

What to Do After Testing

Once testing confirms the new version works well, you can plan the tenant-wide deployment:

• Review test results

Document any issues found and how they were resolved.

• Prepare tenant app catalog

Upload and deploy the tested version to the tenant app catalog.

• Schedule deployment

Choose a maintenance window to minimize disruption.

• Communicate changes

Inform site owners and users about the update and any new features.

• Monitor after deployment

Keep an eye on performance and user feedback to catch any unexpected issues.

If problems arise during tenant deployment, you can revert to the previous version, which can be found in the repository,