Skip to content

Latest commit

 

History

History
155 lines (121 loc) · 3.52 KB

README.md

File metadata and controls

155 lines (121 loc) · 3.52 KB

⚠️ WARNING: DEVELOPMENT IN PROGRESS ⚠️

This package is currently under active development and is NOT ready for production use. The API is unstable and subject to breaking changes. Please check back later for the stable release.

@siteed/publisher

A flexible and powerful release management tool designed for JavaScript/TypeScript monorepos. Automates version management, changelog generation, and package publishing with support for various package managers and CI/CD workflows.

Features

  • 🎯 Monorepo-aware: Handles dependencies and versioning across workspace packages
  • 🔄 Flexible Workflows: Supports different release strategies (independent/fixed/custom)
  • 📦 Package Manager Agnostic: Works with npm, and Yarn
  • 🔧 Highly Configurable: Customize every aspect of your release process
  • 🤖 CI/CD Ready: Automate releases in your CI/CD pipeline
  • 📝 Smart Changelog: Generates and maintains changelogs automatically
  • 🪝 Hooks: Pre and post-release hooks for custom tasks
  • 🔍 Validation: Ensures releases are safe and consistent

Installation

# yarn
yarn add -D @siteed/publisher

Quick Start

  1. Initialize release configuration in your package:
npx publisher init
  1. Configure publisher.config.ts:
import { ReleaseConfig } from '@siteed/publisher';

export default {
  packageManager: 'yarn',
  changelogFile: 'CHANGELOG.md',
  git: {
    tagPrefix: 'v',
    requireCleanWorkingDirectory: true,
    commit: true,
    push: true
  },
  hooks: {
    preRelease: async () => {
      await exec('yarn test');
      await exec('yarn build');
    },
    postRelease: async () => {
      await exec('yarn deploy:docs');
    }
  }
} satisfies ReleaseConfig;
  1. Release your package:
npx publisher publish

Configuration

Global Configuration

Create a .publisher.config.ts in your root directory for monorepo-wide settings:

import { MonorepoConfig } from '@siteed/publisher';

export default {
  versionStrategy: 'independent',
  conventionalCommits: true,
  packageManager: 'yarn',
  gitFlow: false,
  packages: {
    'packages/*': {
      // Default package configuration
    }
  }
} satisfies MonorepoConfig;

Package-specific Configuration

Each package can have its own publisher.config.ts:

export default {
  tagPrefix: 'my-package-v',
  npm: {
    publish: true,
    registry: 'https://registry.npmjs.org'
  },
  hooks: {
    // Package-specific hooks
  }
};

Usage

# Show available commands
publisher --help

# Initialize configuration
publisher init [package]

# Release a specific package
publisher publish my-package

# Release multiple packages
publisher publish pkg1 pkg2

# Release all packages that have changes
publisher publish --all

# Dry run
publisher publish --dry-run

# Custom version
publisher publish --version 1.2.3

Advanced Features

  • Version Strategies

    • Independent: Each package versioned independently
    • Fixed: All packages share the same version
    • Custom: Define your own versioning logic

  • Changelog Generation

    • Conventional commits support
    • Custom templates
    • Multi-package changelogs

  • Git Integration

    • Smart tagging
    • Branch protection
    • Custom commit messages

  • CI/CD Integration

    • Non-interactive mode
    • Environment variable support
    • Custom authentication

Contributing

See CONTRIBUTING.md for development setup and contribution guidelines.

License

MIT © Arthur Breton