Eve library

Neith Release API Reference

Guide

Revision 1

On this page

Reference guide for the public surface of @neith/release.

Entry Points#

typescript
import * as release from '@neith/release';
import * as pipeline from '@neith/release/pipeline';
import * as distribution from '@neith/release/distribution';
import * as platform from '@neith/release/platform';
import * as performance from '@neith/release/performance';

Package Exports#

@neith/release currently publishes the following package exports:

  • @neith/release
  • @neith/release/pipeline
  • @neith/release/distribution
  • @neith/release/platform
  • @neith/release/performance

Shared Types#

src/types.ts defines the shared domain model used across the package:

  • semantic version parsing and release-channel types
  • branching and branch-policy types
  • release candidates and approvals
  • beta and early-access program records
  • rollout, feature-gate, rollback, and lifecycle support structures
  • licensing, installation, and platform publication metadata

Pipeline API#

Module Main exports Purpose
branching-strategy.ts BranchingStrategy, DEFAULT_BRANCH_NAMING, BRANCH_POLICIES release and hotfix branch plans
version-numbering.ts parseSemver, compareSemver, determineBumpType, VersionBumper, CalendarVersioning, VersionHistory semantic and calendar version workflows
release-automation.ts ReleasePipelineBuilder, ReleasePipelineExecutor, PRE_RELEASE_CHECKS, BUILD_STEPS, SECURITY_STEPS, PUBLISH_STEPS pipeline construction and execution
release-candidates.ts ReleaseCandidateManager, RCChangelogGenerator RC creation, gating, and promotion
beta-programs.ts BetaProgramManager beta enrollment and feedback
early-access.ts EarlyAccessManager, EAP_TIER_PERMISSIONS tiered early-access cohorts
staged-rollouts.ts StagedRolloutManager, STANDARD_RINGS, DEFAULT_HEALTH_THRESHOLDS controlled release progression
feature-gates.ts FeatureGateStore, FeatureGateBuilder targeting and flag evaluation
rollback.ts RollbackPlanBuilder, RollbackExecutor, AutoRollbackMonitor, DEPLOYMENT_ROLLBACK_STEPS, DATABASE_ROLLBACK_STEPS rollback orchestration
hotfix.ts HotfixManager, HOTFIX_SLA_DEFINITIONS urgent remediation handling
security-releases.ts calculateCVSSScore, cvssScoreToSeverity, SecurityAdvisoryManager, SecurityReleaseManager security release workflows
lts-support.ts computeLTSSchedule, LTSSupportManager, DEFAULT_LTS_SCHEDULE support-window planning
end-of-life.ts EndOfLifeManager, DEFAULT_EOL_NOTIFICATION_SCHEDULE_DAYS EOL notices and reporting
upgrade-paths.ts UpgradeGraphManager upgrade graph and migration planning
compatibility-matrix.ts CompatibilityMatrixManager, compatibility constants environment support matrices

Example#

typescript
import {
  ReleasePipelineBuilder,
  ReleasePipelineExecutor,
} from '@neith/release/pipeline';

const config = new ReleasePipelineBuilder()
  .forChannel('stable')
  .withPreChecks()
  .withBuild()
  .withSecurity()
  .withPublish()
  .build('Neith Stable');

const workflow = new ReleasePipelineExecutor().toGitHubActionsWorkflow(config);

Distribution API#

Module Main exports Purpose
download-infrastructure.ts DownloadInfrastructure release asset registry and download pages
cdn.ts CDNManager, CacheRuleEngine, RELEASE_CACHE_RULES CDN routing and invalidation
mirror-network.ts MirrorNetworkManager mirror inventory and health
checksum.ts ChecksumVerifier checksum generation and verification
signature.ts SigningManager, DEFAULT_TRUST_POLICY artifact signing and trust policy
installer.ts InstallerBuilder cross-platform installer metadata
package-repos.ts PackageRepositoryManager, generateAptSourcesEntry, generateYumRepoFile, generateHomebrewFormula, generateWingetManifest package repository outputs
auto-update.ts UpdateChecker, UpdateDownloadManager, DEFAULT_AUTO_UPDATE_CONFIG update resolution and downloads
delta-updates.ts DeltaUpdateManager patch generation and savings reports
offline-installer.ts OfflineInstallerBuilder, OfflinePackageRegistry disconnected installation bundles
enterprise-distribution.ts EnterpriseDeploymentGenerator, EnterpriseConfigManager managed enterprise rollout artifacts
site-licensing.ts SiteLicenseManager site-level licensing
volume-licensing.ts VolumeLicenseManager bulk entitlement management
trial-versions.ts TrialManager, DEFAULT_TRIAL_CONFIG trial lifecycle and conversion tracking
freemium.ts FreemiumManager, FREEMIUM_PLANS plan limits and upsell logic

Platform API#

Module Main exports Purpose
linux.ts DebPackageBuilder, RPMSpecBuilder, FlatpakPublisher, AppImageBuilder, LinuxPackageManager Linux packaging
windows.ts WindowsInstallerBuilder WiX/MSIX output helpers
macos.ts MacOSInstallerBuilder DMG, notarization, and package release helpers
ios.ts IOSPublisher App Store and TestFlight publishing
android.ts AndroidPublisher Play Store track publication
steam.ts SteamPublisher Steam depot and build metadata
epic.ts EpicPublisher Epic manifest and submission data
xbox.ts XboxPublisher Microsoft Store and Xbox publication
playstation.ts PlayStationPublisher PlayStation release metadata
nintendo.ts NintendoPublisher Nintendo store packaging
meta-quest.ts MetaQuestPublisher Meta Quest release channels
web.ts WebDeploymentManager, WebAccessibilityAuditor, PRODUCTION_CACHE_STRATEGY, STRICT_SECURITY_HEADERS, WCAG_AA_MINIMUM_CONTRAST_RATIO web distribution and accessibility audits
docker.ts DockerPublisher container publishing
cloud-marketplace.ts AWSMarketplacePublisher, AzureMarketplacePublisher, GCPMarketplacePublisher, CloudMarketplaceManager cloud marketplace listings
enterprise-catalog.ts ServiceNowCatalogPublisher, CoupaCatalogPublisher, SAPAribaCatalogPublisher, InternalPortalPublisher, EnterpriseCatalogManager enterprise software catalogs

Performance API#

Module Main exports Purpose
release-benchmarks.ts RELEASE_BENCHMARK_BUDGETS, RELEASE_BENCHMARK_BASELINES, evaluateReleaseBenchmarkRegression, formatReleaseBenchmarkReport, formatReleaseBenchmarkRegressionReport benchmark budgets, certified baselines, and regression report formatting

The performance entry point also exposes benchmark baseline, report, metrics, result, and regression-report types for downstream validation workflows.

Operational Notes#

  • The package is intentionally side-effect light. Most APIs return data, manifests, generated text, or command lists.
  • Use package tests as executable examples for edge cases and expected output shape.