ReleasedPackages Quick Reference
Package and release OpenForum pages for deployment to other sites
Key Features
- Create versioned release packages
- Track release history and versions
- Package pages with all dependencies
- Release notes management
- Pre-release and post-install scripts
- Exclude files from releases
- Remove old releases
- View release package information
Server-Side Usage:
<![CDATA[
// Get the ReleasedPackages API
var ReleasedPackages = js.getObject("/OpenForum/AddOn/ReleasedPackages","ReleasedPackages.sjs");
// Release a page
ReleasedPackages.releasePage("/MyPage", "1.0.0", "Release notes");
// Get release information
var releaseInfo = ReleasedPackages.getReleaseInfo("/MyPage", "1.0.0");
// List all releases
var releases = ReleasedPackages.listReleases();
// Remove a release
ReleasedPackages.removeRelease("/MyPage", "1.0.0");
// Get release package
var packageData = ReleasedPackages.getPackage("/MyPage", "1.0.0");
]]>
Client-Side Usage:
<![CDATA[
// Release a page
JSON.post('/OpenForum/AddOn/ReleasedPackages/Release', null,
'pageName=/MyPage&version=1.0.0¬es=' encodeURIComponent('Release notes'))
.onSuccess(function(result) {
console.log('Page released:', result);
}).go();
// List releases
JSON.get('/OpenForum/AddOn/ReleasedPackages/List')
.onSuccess(function(releases) {
console.log('Releases:', releases);
}).go();
// Remove release
JSON.post('/OpenForum/AddOn/ReleasedPackages/Remove', null,
'pageName=/MyPage&version=1.0.0')
.onSuccess(function(result) {
console.log('Release removed');
}).go();
]]>
Special Files
- pre-release.sjs - Script run on releasing server before the release package is built
- release-excludes-files.json - List of files to exclude from release (supports regex like `.*-test.js`)
- release-info.json - Contains release information (version, timestamp, notes)
- install.sjs - Run on target server after package installation
Release Process
1. Create release notes for the version
2. Optional: Add page-specific notes
3. Run pre-release.sjs (if present) for validation
4. Create ZIP package excluding specified files
5. Store release with version number and timestamp
6. Generate release-info.json metadata
Configuration
- Version numbering scheme
- Release storage location
- Excluded file patterns
- Notification settings