ProgramModule
PackageFsLiveDocs
Summary
| Name | Signature | Synopsis |
|---|---|---|
| Operations | ||
| printBanner | printBanner () | No description available. |
| getUnifiedPackage | getUnifiedPackage projectPaths | No description available. |
| auditAction | auditAction warnAsError projectPaths | No description available. |
| captureAction | captureAction warnAsError dryRun projectPaths version output | No description available. |
| expandUrlPattern | expandUrlPattern pattern version | Expands {version} and {tag} in a configured capsule URL pattern. |
| historyAddAction | historyAddAction indexPath version capsulePath capsuleUrl checksum sha256File | No description available. |
| buildAction | buildAction warnAsError projectPaths theme version | Orchestrates the build process for one or more projects. |
| renderHistoryInto | renderHistoryInto manifestPath theme retryAttempts outputDir | Renders every version in a manifest into <paramref name="outputDir"/>. |
| buildHistoryAction | buildHistoryAction manifestPath theme retryAttempts | No description available. |
| historyCheckAction | historyCheckAction indexPath candidateCapsule candidateVersion theme retryAttempts | Renders the committed history — optionally with a local candidate capsule spliced in as the release under test — into a temporary directory and verifies it. |
| main | main args | CLI entry point. |
Operations
kind:member
kind:member
kind:member
kind:member
kind:member
kind:member
kind:member
Renders every version in a manifest into <paramref name="outputDir"/>. Shared by
`build-history` (which then indexes the site) and `history check` (which verifies it).
Parameters
| Name | Type | Description |
|---|---|---|
| manifestPath | string | |
| theme | string | |
| retryAttempts | int | |
| outputDir | string |
Returns
unit
kind:member
kind:member
historyCheckAction indexPath candidateCapsule candidateVersion theme retryAttempts
Member
Renders the committed history — optionally with a local candidate capsule spliced in as
the release under test — into a temporary directory and verifies it. Never writes the index.
Parameters
| Name | Type | Description |
|---|---|---|
| indexPath | string | |
| candidateCapsule | string option | |
| candidateVersion | string option | |
| theme | string | |
| retryAttempts | int |
Returns
int