Skip to content

Latest commit

 

History

History
80 lines (57 loc) · 4.09 KB

portalfx-pde-publish.md

File metadata and controls

80 lines (57 loc) · 4.09 KB

Sharing your PDE with other teams

The following guidelines have been created to ensure a consistent and easy to consume developer experience across all partner teams that need to share their PDE.

To share your PDE with other teams please follow these guidelines:

  • Create a NuGet

    • use the consistent naming convention Microsoft.Portal.Extensions.<Name>
    • the *.pde file is to be delivered under /Client/_extensions/<Name>
    • all *.d.ts files to be delivered under /Client/_extensions/<Name>/*.d.ts

    The following nuproj snippet can be used to customimze for your extensions NuGet creation. Most teams name it Microsoft.Portal.Extensions.<Name> to be consistent with the produced package name

    <?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="4.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<Import Project="$(EnvironmentConfig)" />

<PropertyGroup>
    <Id>Microsoft.Portal.Extensions.Name</Id>
    <Title>Microsoft Portal Extension Name</Title>
    <Description>Provides the Microsoft Portal Name PDE</Description>
    <Summary>Provides the Microsoft Portal Name PDE</Summary>
    <Tags>Microsoft Azure Cloud Portal Framework Name  PDE</Tags>
</PropertyGroup>

<ItemGroup>
    <!-- update the following to pull the PDE from your official build-->
    <Content Include="$(RepoRoot)\src\SDK\Extensions\HubsExtension\Extension\TypeScript\HubsExtension\HubsExtension.pde">
    <!-- update the following to pull in any *.d.ts files that consumers of your extensions PDE will require -->
    <Content Include="$(RepoRoot)\src\SDK\Extensions\HubsExtension\Extension\TypeScript\HubsExtension\ForExport\*.d.ts">
    <TargetPath>Client\_extensions\Name</TargetPath>
    </Content>
    <!-- include an install.ps1 to both set appropriate build action on pde and to pop documents-->
    <File Include="$(REPOROOT)\RDPackages\NuGet\Microsoft.Portal.Extensions.Name\Install.ps1" >
    <TargetPath>Tools\Install.ps1</TargetPath>
    </File>
</ItemGroup>
<!-- update the following as needed aka.ms/onebranch -->
<Import Project="$(PkgNuProj)\NuProj.Targets" />
<Import Project="..\Portal.Common.NuGet.props" />
<PropertyGroup>
    <GenerateSymbolPackage>false</GenerateSymbolPackage>
</PropertyGroup>
</Project>

  • Include in the nuproj a Install.ps1 that will:

    • set the correct build action on PDE
    • and open documentation on how to consume the exposed content.

    Customize the following Install.ps1 script

    param($installPath, $toolsPath, $package, $project)

# set the build action for the pde to ExtensionResource
$item = $project.ProjectItems.Item("Client").ProjectItems.Item("_extensions").ProjectItems.Item("Your Folder Name that nuproj puts the pde in").ProjectItems.Item("SomeExtension.pde") 
$item.Properties.Item("ItemType").Value = "ExtensionReference"
# open the documentation for consuming exposed content from the pde. use an aka.ms link so you can change out the target content without having to republish
$DTE.ItemOperations.Navigate("https://aka.ms/portalfx/somepde")

  • Now that the NuGet is created as part of your build you need to create a document for consuming the content exposed by the PDE

  • The resulting NuGet is to be published from your official builds to https://msazure.visualstudio.com/One/Azure%20Portal/_packaging?feed=Official&_a=feed. See OneBranch guidance to publish your package