PacletAssurance`
PacletAssurance`

PacletBuildInstall

PacletBuildInstall[paclet]

builds paclet using PacletBuild before installing with PacletInstall

Details and Options

  • PacletBuildInstallensures that a paclet's functionality and documentation becomes persistently available.
  • PacletBuildInstallperforms a native build and install in contrast to PacletDeploy that performs extra configuration designed for commercial deployment.
  • PacletBuildInstallforms an important, intermediary step in workflows encompassing paclet creation through to paclet deployment.

Examples

Basic Examples  (1)

Create OnsocExamplePaclet and have it automatically placed in $DeveloperDirectory

Make the paclet's functionality available by switching on development

Load the package to test its functionality

Evaluate one of the functions in OnsocExamplePackage`

Further development on the package's code-base can now proceed and be tested through iterative calls to Get["OnsocExamplePackage"] without leaving the development environment. There are however, some circumstances where it can be advantageous to instead build and install the paclet/package in its current state and have its functionality available in a normal kernel session. This can occur, for example when:

1. Part of the development involved extensive changes to the documentation.

2. Testing is needed more in-situ.

3. The functionality, if not finely polished, is nonetheless sufficiently useful for use in other projects.

In this case the current state of the developer package can be installed.

Now the paclet's functionality is available across sessions. Quit the Kernel

Load the package

Evaluate one of the added functions

uninstall the installed version

Tech Notes
  • Paclet Workflow