Skip to main content

Quick Start

Get started with Universal Release in under 5 minutes.

Step 1: Create Configuration​

Create a .release.yaml file in your project root:

version: 1
global:
  versionScheme: semantic
  commitConvention: conventional-commits
ecosystems:
  npm:
    enabled: true
    validation:
      build: true
      test: true

Step 2: Store Credentials​

Store your registry token securely in the OS keychain:

release secrets set NPM_TOKEN

Enter your token when prompted. It will be encrypted and stored in your system's credential manager (Keychain on macOS, Credential Manager on Windows, libsecret on Linux).

Step 3: Test Your Release​

Perform a dry run to test without actually publishing:

release publish --dry-run

This will:

  • Validate your configuration
  • Run build and tests
  • Prepare the package
  • Show what would be published

Step 4: Publish​

If the dry run succeeds, publish for real:

release publish

What Just Happened?​

Universal Release:

  1. Detected your ecosystem (npm in this case)
  2. Read your current version
  3. Ran validations (build, tests)
  4. Published to the registry
  5. Verified the publication

Next Steps​