Meet the (Brand new) Advanced Powershell Packaging Features

July 6, 2023 Rodrigo Peplau 0

TL; DR

• Sitecore Powershell Extensions (SPE) 7.0 introduces advanced packaging features, but you can also enjoy them in past SPE versions by using our package or Gist.
• You can now selectively include linked items in packages, avoiding the classic all-or-nothing approach.
• Learn how the features work and how to use them.

 

Introduction

Get ready for an exciting update, folks! Sitecore PowerShell Extensions (SPE) 7.0 is rolling out by the end of this year with some seriously cool new features in the packaging department. And guess what? I had the privilege of implementing these features, which were received very positively by the SPE team (shoutout to the amazing Michael West for his support!)

 

Also available for older versions of SPE

But fear not, even if you’re using a lower version of SPE, you can still reap the benefits by installing the necessary scripts using the following package: Advanced-Packaging-Features-1-0-zip. Or manually creating the 5 scripts at their respective paths according to this Gist.

Let’s dive into what these advanced packaging features are all about and how to make the most of them!

 

Rebuild your Link Database

First things first: the new features depend on the Link Database, so you will have to keep it up-to-date. If you are unsure, remember to give your Link Database a good rebuild for the “master” database, at least once before utilizing these features.

 

Unlocking Selective Packaging Superpowers

Currently, the SPE UI allows you to include linked items in your package, but it is an all-or-nothing deal. If you want to include media items linked to your selected item, you had no choice but to include all of them.

This is how the classic interface works, based on checkboxes:

Well, hold on to your keyboards because the new advanced packaging features now empower you to cherry-pick and selectively include linked items to your package.

The new UI will now show a different set of radio box configurations:

1. Do not include linked items: Linked items are not included in the package.
2. Include parent links only: Only items linked to the selected item (parent) will be considered for inclusion.
3. Include all linked items: All linked items (parent and children) will be considered for inclusion.

 

If you select either 2 or 3, a new screen will show, allowing you to cherry-pick the linked items you want to include in the package.

As you can see, there are tabs for each kind of linked items (Content, Media, Layouts, System, Templates), making the selection process much easier.

 

Using the New Features

To access these supercharged packaging powers, simply right-click on any item in the Content Editor and navigate to Scripts > Packaging.

• Important: Starting from SPE 7.0 the original features were substituted with the new ones, so you will see the list as above. However, if you’re using the new features in older SPE versions through my package or Gist, then you’ll notice I’ve added the new features to scripts sufixed with “Advanced”, as can be seen below:

Let’s take a closer look at the options available to fight the packaging confusion crimes, powered by Sitecore PowerShell Extensions:

 

Quick Download Tree as a Package (Advanced)

This option allows you to download as a package the selected item, along with the additional items you choose to include in the package. You can add child items, and selectively pick those linked items that deserve a spot in your package.

 

Start New Package (Advanced)

Choosing this option initiates the creation of a new package without immediately downloading it. Don’t worry, though – you’ll have the option to download it later. Once you’ve made this selection, a host of further options becomes available:

1. Add Item to Package (Advanced): This handy feature lets you add the selected item, along with any linked items you desire, to your package.
2. Add Tree to Package (Advanced): Selecting this option adds the selected item, all its children, and the linked items you choose to your package.
3. Preview Package Items (Advanced): Curious about the contents of your package before sealing the deal? This option lists all the items currently added to your package, allowing you to ensure you’ve got items you envisioned.
4. Download Package (Advanced): Finally, when you’re ready to unleash your package upon the world, hit “Download Package”. Your meticulously crafted package, complete with its formidable lineup of items, will be ready for action!

 

Conclusion

With Sitecore Powershell Extensions 7.0’s advanced packaging features, you now have the power to curate packages like never before. No more settling for all or nothing – select the linked items that truly matter and assemble the perfect package for your Sitecore adventures. So, go ahead and embrace these newfound packaging superpowers.
Get ready to package up greatness, fellow Sitecore heroes!

Categories: Powershell, SPE