Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Share Release Notes and Post-Install Instructions

Share details about what’s new and changed in a released unlocked package with your users.

Share details about what’s new and changed in an unlocked package with your users. You can specify a release notes URL to display on the package detail page in the user’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 users who install packages using an installation URL, the package installer page displays a link to release notes. And users 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         "postInstallUrl": "https://expenser.com/post-install-instructions.html",
9         "releaseNotesUrl": "https://expenser.com/winter-2020-release-notes.html"
10        },
11        ],
12       {
13         "namespace": "",
14         "sfdcLoginUrl": "https://login.salesforce.com",
15         "sourceApiVersion": "47.0",
16         "packageAliases": {
17             "Expenser Schema": "0HoB00000004CzHKAU",
18             "Expenser Schema@0.1.0-1": "04tB0000000719qIAA"
19      }
20}

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.

Salesforce DX Developer Guide

Share Release Notes and Post-Install Instructions