Salesforce DX Developer Guide

How Salesforce Developer Experience Changes the Way You Work
Salesforce CLI Configuration and Tips
Project Setup
Authorization
Metadata Coverage
Scratch Orgs
Sandboxes
Development
Build and Release Your App
First-Generation Managed Packages
Second-Generation Managed Packages
Unlocked Packages
What’s a Package
Package-Based Development Model
Before You Create Unlocked Packages
Know Your Orgs
Workflow for Unlocked Packages
Configure Packages
Project Configuration File for Packages
Keywords
Package Installation Key
Extract Dependency Information from Unlocked Packages
Understanding Namespaces
Share Release Notes and Post-Install Instructions
Best Practices for Unlocked Packages
Package IDs and Aliases
Frequently Used Packaging Operations
Create a Package
Install a Package
Migrate Deprecated Metadata from Unlocked Packages
Uninstall a Package
Continuous Integration
Troubleshoot Salesforce DX
Limitations for Salesforce DX
PDF

Newer Version Available

This content describes an older version of this product. View Latest

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.

You can also use the --postinstallurl and the --releasenotesurl Salesforce CLI parameters with the force:package:version:createcommand. The CLI parameters override the URLs specified in the sfdx-project.json file.