Share Release Notes and Post-Install Instructions for Second-Generation Managed Packages

Share details with your subscribers about what’s new and changed in a released second-generation managed package.

You can specify a release notes URL to display on the package detail page in the subscriber’s org. And you can share instructions about using your package by specifying a post install URL. The release notes and post install URLs display on the Installed Packages page in Setup, after a successful package installation. For subscribers who install packages using an installation URL, the package installer page displays a link to release notes. And subscribers are redirected to your post install URL following a successful package installation or upgrade.

Specify the postInstallUrl and releaseNotesUrl attributes in the packageDirectories section for the package.

1"packageDirectories": [
2      {
3         "path": "expenser-schema",
4         "default": true,
5         "package": "Expense Schema",
6         "versionName": ""ver 0.3.2"",
7         "versionNumber": "0.3.2.NEXT",
8         "postInstallScript": "PostInstallScript",
9         "uninstallScript": "UninstallScript",
10         "postInstallUrl": "https://expenser.com/post-install-instructions.html",
11         "releaseNotesUrl": "https://expenser.com/winter-2020-release-notes.html"
12        },
13        ],
14       {
15         "namespace": "db_exp_manager",
16         "sfdcLoginUrl": "https://login.salesforce.com",
17         "sourceApiVersion": "47.0",
18         "packageAliases": {
19             "Expenser Schema": "0HoB00000004CzHKAU",
20             "Expenser Schema@0.1.0-1": "04tB0000000719qIAA"
21         }

You can also use the --post-install-url and the --release-notes-url Salesforce CLI parameters with the sf package version create command. The CLI parameters override the URLs specified in the sfdx-project.json file.

Second-Generation Managed Packaging Developer Guide

Share Release Notes and Post-Install Instructions for Second-Generation Managed Packages