relizy 0.3.0 → 1.0.0-beta.0

package/README.md

@@ -7,7 +7,24 @@
       A tool to manage releases for monorepos and single packages.
     </strong>
   </p>
-  <a href="https://louismazel.github.io/relizy/">Documentation</a>
+
+  <p>
+    <a href="https://codecov.io/gh/LouisMazel/relizy">
+      <img src="https://codecov.io/gh/LouisMazel/relizy/branch/main/graph/badge.svg?token=YOUR_TOKEN_HERE" alt="codecov" />
+    </a>
+    <a href="https://github.com/LouisMazel/relizy/actions/workflows/test-unit.yml">
+      <img src="https://github.com/LouisMazel/relizy/actions/workflows/test-unit.yml/badge.svg" alt="Unit Tests" />
+    </a>
+    <a href="https://www.npmjs.com/package/relizy">
+      <img src="https://img.shields.io/npm/v/relizy.svg" alt="npm version" />
+    </a>
+    <a href="https://www.npmjs.com/package/relizy">
+      <img src="https://img.shields.io/npm/dm/relizy.svg" alt="npm downloads" />
+    </a>
+  </p>
+
+<a href="https://louismazel.github.io/relizy/">Documentation</a>
+
 </div>
 
 ---
@@ -22,6 +39,7 @@ Imagine you have multiple packages in your project (like a box with several toys
 2. **Create changelogs** to explain what changed
 3. **Publish your packages** to npm so others can use them
 4. **Create releases** on GitHub or GitLab
+5. **Announce releases** automatically on Twitter and Slack
 
 ## ✨ Features
 
@@ -32,11 +50,12 @@ Imagine you have multiple packages in your project (like a box with several toys
 - 🏷️ Pre-release support (alpha, beta, rc)
 - 📢 NPM publish with smart tag detection
 - 🔗 Automatic dependency bumping for workspace dependencies
-- 🐙 GitHub & GitLab release automation
+- 🐙 GitHub, GitLab & Bitbucket support
 - 🔐 2FA/OTP support for npm publishing
 - 🎛️ Custom registry support (private registries, GitHub Packages, etc.)
 - ⚙️ Multiple configuration files support for different release workflows
 - 🔧 Support for npm, yarn, pnpm, and bun (auto-detected)
+- 📱 Social media integration (Twitter & Slack) for release announcements
 
 ## 📚 Documentation
 
@@ -48,1189 +67,186 @@ You can [find the documentation here](https://louismazel.github.io/relizy/).
 pnpm add -D relizy
 ```
 
-## 📦 Package Manager Support
-
-This tool automatically detects your package manager and uses the appropriate commands:
-
-- **npm** - Standard npm registry commands
-- **yarn** - Supports both Yarn Classic and Yarn Berry
-- **pnpm** - Optimized for pnpm workspaces
-- **bun** - Full support for bun package manager
-
-Detection is automatic based on:
-
-1. `packageManager` field in package.json
-2. Lock file presence (pnpm-lock.yaml, yarn.lock, package-lock.json, bun.lockb)
-3. npm_config_user_agent environment variable
-
-## ⚙️ Minimal configuration
-
-Create a configuration file in the root of your project. The config file is loaded using [c12](https://github.com/unjs/c12), which supports multiple formats.
-
-### Supported Configuration Formats
-
-You can use any of these formats for your configuration file:
+## 🚀 Quick Start
 
-- **JavaScript/TypeScript:** `.js`, `.ts`, `.mjs`, `.cjs`, `.mts`, `.cts`
-- **JSON:** `.json`, `.jsonc`, `.json5`
-- **YAML:** `.yaml`, `.yml`
-- **TOML:** `.toml`
+Install Relizy in your project:
 
-**Examples:**
-
-- `relizy.config.ts` (TypeScript - recommended)
-- `relizy.config.js` (JavaScript)
-- `relizy.config.json` (JSON)
-- `relizy.config.yaml` (YAML)
-
-### Minimal Configuration Example
+```bash
+pnpm add -D relizy
+# or npm install -D relizy
+# or yarn add -D relizy
+```
 
-**TypeScript/JavaScript** (recommended):
+Create a simple configuration file `relizy.config.ts`:
 
 ```typescript
-// relizy.config.ts
 import { defineConfig } from 'relizy'
 
 export default defineConfig({
   monorepo: {
-    versionMode: 'selective', // 'unified', 'selective', 'independent'
-    packages: ['packages/*'], // glob pattern matching
+    versionMode: 'selective',
+    packages: ['packages/*'],
   },
 })
 ```
 
-**JSON:**
-
-```json
-{
-  "monorepo": {
-    "versionMode": "selective",
-    "packages": ["packages/*"]
-  }
-}
-```
-
-**YAML:**
-
-```yaml
-monorepo:
-  versionMode: selective
-  packages:
-    - packages/*
-```
-
-Check all options in the [configuration section](#configuration-options).
-
-## 🚀 Usage
-
-### Available commands
-
-The CLI uses the `relizy` command:
+That's it! Now you can release with a single command:
 
 ```bash
-relizy <command> [options]
-```
-
-#### 1. `release` - Complete release workflow
-
-Executes the entire release workflow in one command:
-
-1. Bump versions
-2. Generate changelogs
-3. Commit changes
-4. Create git tag
-5. Push to remote
-6. Publish to npm
-7. Create GitHub or GitLab release
-
-```bash
-# Complete release
 relizy release
-
-# Release with pre-release
-relizy release --prerelease --preid beta --tag beta
-
-# Release with custom suffix (see bump --suffix)
-relizy release --prerelease --preid beta --suffix abc123
-
-# Without push to remote
-relizy release --patch --no-push
-
-# Without GitHub/GitLab release creation
-relizy release --patch --no-provider-release
-
-# Without npm publish
-relizy release --patch --no-publish
-
-# Without git verification (skip hooks)
-relizy release --patch --no-verify
-
-# With npm options
-relizy release --patch --registry https://npm.pkg.github.com --access public --otp 123456
-
-# Force even without commits
-relizy release --patch --force
 ```
 
-**Available options:**
-
-All options from `bump`, `changelog`, `publish` and `provider-release` are available, and:
+This will automatically:
 
-- `--no-push` - Don't push changes and tags to remote
-- `--no-provider-release` - Don't create GitHub/GitLab release
-- `--no-publish` - Don't publish to npm
-- `--no-verify` - Skip git hooks during commit
-- `--no-commit` - Skip commit and tag creation
-- `--no-changelog` - Skip changelog generation
-- `--no-clean` - Skip working directory clean check
-- `--token <token>` - Git token (GitHub or GitLab)
-- `--force` - Force bump even without commits
-- `--yes` - Skip confirmation prompt
-- `--build-cmd <cmd>` - Command to build packages before publish
-- `--suffix <suffix>` - Custom suffix for prerelease versions (see [bump --suffix](#--suffix))
+- Detect the version bump from your commits
+- Update all package versions
+- Generate changelogs
+- Commit and tag your changes
+- Push to your git repository
+- Create a release on GitHub/GitLab
+- Publish to npm
 
-#### 2. `bump` - Update versions
+## 💡 What Can You Use This For?
 
-Updates package version numbers.
-
-```bash
-# Auto-detect bump type from commits
-relizy bump
-
-# Specify bump type
-relizy bump --patch    # 1.0.0 → 1.0.1
-relizy bump --minor    # 1.0.0 → 1.1.0
-relizy bump --major    # 1.0.0 → 2.0.0
-
-# Pre-releases
-relizy bump --prerelease --preid beta     # 1.0.0 → 1.0.1-beta.0
-relizy bump --premajor --preid alpha      # 1.0.0 → 2.0.0-alpha.0
-relizy bump --preminor --preid rc         # 1.0.0 → 1.1.0-rc.0
-relizy bump --prepatch --preid beta       # 1.0.0 → 1.0.1-beta.0
-
-# Pre-releases with custom suffix
-relizy bump --prepatch --preid beta --suffix abc123    # 1.0.0 → 1.0.1-beta.abc123
-relizy bump --prerelease --preid alpha --suffix 20241106  # 1.0.0-alpha.0 → 1.0.0-alpha.20241106
-
-# Options
-relizy bump --force      # Force bump even without commits
-relizy bump --yes        # Skip confirmation prompt
-relizy bump --no-clean   # Skip working directory clean check
-```
+Relizy isn't just for publishing npm packages. You can use it for any project where you need version tracking and changelogs:
 
-**Available options:**
+### Publishing npm Packages
 
-- `--major` - Bump major version
-- `--minor` - Bump minor version
-- `--patch` - Bump patch version
-- `--prerelease` - Bump prerelease version
-- `--premajor` - Bump premajor version
-- `--preminor` - Bump preminor version
-- `--prepatch` - Bump prepatch version
-- `--preid <id>` - Prerelease identifier (alpha, beta, rc, etc.)
-- `--suffix <suffix>` - Custom suffix for prerelease versions
-- `--force` - Force bump even without commits
-- `--yes` - Skip confirmation prompt
-- `--no-clean` - Skip working directory clean check
-
-##### `--suffix`
-
-The `--suffix` option allows you to customize the prerelease version number with a custom identifier instead of an auto-incremented number. This is particularly useful for CI/CD pipelines where you want to include build metadata in your version.
-
-**How it works:**
-
-When you use a prerelease bump type (`prepatch`, `preminor`, `premajor`, or `prerelease`) with the `--suffix` option, the version number's prerelease suffix will be replaced with your custom value instead of an auto-incremented number.
-
-**Examples:**
+Perfect for managing npm packages in a monorepo or single package repository. Automate the entire release workflow and let your team focus on building features.
 
 ```bash
-# Without suffix (default behavior)
-relizy bump --prepatch --preid beta
-# 1.0.0 → 1.0.1-beta.0
-
-# With custom suffix
-relizy bump --prepatch --preid beta --suffix abc123
-# 1.0.0 → 1.0.1-beta.abc123
-
-# Incrementing an existing prerelease with suffix
-relizy bump --prerelease --preid beta --suffix xyz789
-# 1.0.1-beta.0 → 1.0.1-beta.xyz789
-
-# Common CI/CD use case: Git commit SHA
-relizy bump --prerelease --preid alpha --suffix $(git rev-parse --short HEAD)
-# 1.0.0-alpha.5 → 1.0.0-alpha.a1b2c3d
-
-# Common CI/CD use case: Build number
-relizy bump --prepatch --preid rc --suffix ${CI_PIPELINE_ID}
-# 2.5.0 → 2.5.1-rc.12345
-
-# Common CI/CD use case: Timestamp
-relizy bump --preminor --preid beta --suffix $(date +%Y%m%d%H%M%S)
-# 1.0.0 → 1.1.0-beta.20241106153045
+relizy release --minor
 ```
 
-**Important notes:**
-
-- The `--suffix` option **only works with prerelease bump types** (`prepatch`, `preminor`, `premajor`, `prerelease`)
-- It has **no effect on stable release types** (`patch`, `minor`, `major`)
-- The suffix can contain letters, numbers, or hyphens
-- Suffix values follow semantic versioning rules for prerelease identifiers
-
-**Use cases:**
-
-1. **CI/CD Pipelines**: Include build numbers, commit SHAs, or timestamps in your prerelease versions
-2. **Feature Branches**: Create unique prerelease versions for different branches
-3. **Testing**: Generate identifiable test releases
-4. **Reproducible Builds**: Track exact build metadata in version numbers
+### Versioning Private Applications
 
-**Example in CI/CD (GitHub Actions):**
-
-```yaml
-- name: Bump prerelease version
-  run: |
-    pnpm relizy bump --prerelease --preid beta --suffix ${{ github.sha }}
-```
-
-**Example in CI/CD (GitLab CI):**
-
-```yaml
-bump:
-  script:
-    - pnpm relizy bump --prepatch --preid rc --suffix $CI_COMMIT_SHORT_SHA
-```
-
-#### 3. `changelog` - Generate changelogs
-
-Generates CHANGELOG.md files for each package and at the root.
+Use Relizy to version your private web applications, mobile apps, or internal tools. Keep track of what changed in each version with automatic changelog generation.
 
 ```bash
-# Generate all changelogs
-relizy changelog
-
-# Specify commit range
-relizy changelog --from v1.0.0
-relizy changelog --from v1.0.0 --to v1.1.0
-
-# Format after generation
-relizy changelog --format-cmd "pnpm lint:fix"
-
-# Without root changelog
-relizy changelog --no-root-changelog
-```
-
-**Available options:**
-
-- `--from <ref>` - Start commit reference
-- `--to <ref>` - End commit reference
-- `--format-cmd <cmd>` - Command to format CHANGELOGs after generation
-- `--no-root-changelog` - Skip root changelog generation
-
-#### 4. `publish` - Publish to npm
-
-Publishes packages to npm registry (or other registry).
-
-```bash
-# Simple publish
-relizy publish
-
-# With custom registry
-relizy publish --registry https://npm.pkg.github.com
-
-# With custom tag
-relizy publish --tag next
-
-# For scoped packages (public access)
-relizy publish --access public
-
-# With 2FA
-relizy publish --otp 123456
-
-# Build before publish
-relizy publish --build-cmd "pnpm build"
+relizy release --patch --no-publish
 ```
 
-**Available options:**
-
-- `--registry <url>` - Custom npm registry URL
-- `--tag <tag>` - Publish tag (default: `latest` for stable, `next` for prerelease)
-- `--access <type>` - Access level (`public` or `restricted`)
-- `--otp <code>` - OTP code for 2FA
-- `--build-cmd <cmd>` - Command to build packages before publish
+### Release Announcements
 
-**Automatic tag detection:**
-
-- Stable version (e.g., `1.2.3`) → tag `latest`
-- Prerelease version (e.g., `1.2.3-beta.0`) → tag `next`
-
-#### 5. `provider-release` - Publish a release to git provider (github or gitlab)
-
-Publishes a release for the latest tag.
+Automatically post release announcements to Twitter and Slack when you ship new versions. Keep your users and team informed without manual work.
 
 ```bash
-# Publish release
-relizy provider-release
-
-# With custom token
-relizy provider-release --token YOUR_GITHUB_TOKEN
-
-# Force git provider
-relizy provider-release --provider github
-
-# Specify range
-relizy provider-release --from v1.0.0 --to v1.1.0
+relizy release --minor  # Automatically posts to configured social channels
 ```
 
-**Available options:**
+## 📖 Learn More
 
-- `--from <ref>` - Start commit reference
-- `--to <ref>` - End commit reference
-- `--token <token>` - Git provider token
-- `--provider <provider>` - Git provider (github or gitlab)
+This README covers the basics to get you started quickly. For detailed documentation, configuration options, and advanced features, visit our full documentation:
 
-**Token:**
+**[📚 Full Documentation](https://louismazel.github.io/relizy/)**
 
-Multiple ways to provide the token:
+Topics covered in the documentation:
 
-- Command line option (`--token`)
-- Configuration file (see [tokens](#tokens) section)
-- Environment variables (checked in order):
-  - **GitHub:** `RELIZY_GITHUB_TOKEN`, `GITHUB_TOKEN`, `GH_TOKEN`
-  - **GitLab:** `RELIZY_GITLAB_TOKEN`, `GITLAB_TOKEN`, `GITLAB_API_TOKEN`, `CI_JOB_TOKEN`
+- Complete configuration reference
+- Monorepo versioning strategies (unified, selective, independent)
+- CI/CD integration (GitHub Actions, GitLab CI)
+- Social media integration (Twitter & Slack)
+- Custom registries and private packages
+- Multiple configuration files
+- And much more...
 
-### Global options
+## 🎨 Common Use Cases
 
-All commands support these global options:
+Here are some quick examples to get you started:
 
-#### Config File
-
-Use `--config` to specify a custom configuration file name (without the file extension):
+### Release a Patch Version
 
 ```bash
-# Use default config (relizy.config.{ts,js,json,yaml,...})
-relizy bump --patch
-
-# Use custom config (relizy.standalone.config.{ts,js,json,yaml,...})
-relizy bump --config relizy.standalone --patch
-
-# Use another config (relizy.experimental.config.{ts,js,json,yaml,...})
-relizy release --config relizy.experimental --minor
+relizy release --patch
 ```
 
-**Important:**
+This bumps the version (e.g., 1.0.0 → 1.0.1), generates the changelog, commits, tags, pushes, and publishes to npm.
 
-- The config file name must follow the pattern: `<name>.config.<ext>` (e.g., `myconfig.config.ts`, `myconfig.config.json`)
-- In the `--config` option, you only specify the `<name>` part (without `.config.<ext>`)
-- Supported extensions: `.ts`, `.js`, `.mjs`, `.cjs`, `.mts`, `.cts`, `.json`, `.jsonc`, `.json5`, `.yaml`, `.yml`, `.toml`
-
-#### Dry Run
-
-Use `--dry-run` to preview changes without writing files, creating tags, commits, or publishing:
+### Try Before You Commit (Dry Run)
 
 ```bash
-# Preview bump
-relizy bump --patch --dry-run
-
-# Preview entire release workflow
 relizy release --minor --dry-run
-
-# Preview publish
-relizy publish --dry-run
 ```
 
-#### Log Level
+Preview exactly what will happen without making any changes.
 
-Use `--log-level` to control verbosity:
+### Skip Publishing for Private Apps
 
 ```bash
-# Default level (essential information)
-relizy bump
-
-# Debug level (detailed information)
-relizy release --patch --log-level debug
-
-# Silent level (errors only)
-relizy publish --log-level silent
+relizy release --patch --no-publish
 ```
 
-**Available levels:**
+Perfect for versioning private applications where you don't need to publish to npm.
 
-- `silent` - Errors only
-- `error` - Errors and critical warnings
-- `warning` - Warnings and above
-- `normal` - Normal information
-- `default` - Essential information (default)
-- `debug` - Detailed debugging information
-- `trace` - Very detailed trace information
-- `verbose` - Show everything
-
-**Examples:**
+### Pre-release Versions
 
 ```bash
-# Clean output with essential info
-$ relizy bump --patch
-ℹ 4.2.0 → 4.2.1 (unified mode)
-✔ All 3 package(s) bumped to 4.2.1
-
-# Detailed output for debugging
-$ relizy bump --patch --log-level debug
-● Loading monorepo configuration
-● Version mode: unified
-● From: v4.2.0, To: HEAD
-● Package patterns: packages/*
-● Found 3 package(s)
-● Starting bump in unified mode
-● Fetching commits from v4.2.0 to HEAD
-● Found 5 commits since v4.2.0
-● Detected release type from commits: patch
-ℹ 4.2.0 → 4.2.1 (unified mode)
-● Writing version to 3 package(s)
-● Updating lerna.json version
-✔ All 3 package(s) bumped to 4.2.1
-```
-
-## ⚙️ Configuration
-
-This tool extends [changelogen](https://github.com/unjs/changelogen) configuration with additional monorepo-specific options. Some options from changelogen are overridden to provide better monorepo support.
-
-Create a `relizy.config.ts` file at the root of your project:
-
-```typescript
-import { defineConfig } from 'relizy'
-
-export default defineConfig({
-  // Standard changelogen configuration
-  types: {
-    feat: { title: '🚀 Features', semver: 'minor' },
-    fix: { title: '🩹 Fixes', semver: 'patch' },
-  },
-
-  // Monorepo configuration
-  monorepo: {
-    versionMode: 'selective',
-    packages: ['packages/*'],
-    ignorePackageNames: [],
-  },
-
-  // Optional configuration
-  changelog: {
-    formatCmd: 'pnpm lint:fix',
-    rootChangelog: true,
-  },
-
-  bump: {
-    type: 'release',
-    preid: undefined,
-  },
-
-  publish: {
-    private: false,
-    tag: 'latest',
-    args: [],
-  },
-
-  release: {
-    push: true,
-    release: true,
-    publish: true,
-    noVerify: false,
-  },
-})
-```
-
-### Configuration options
-
-The configuration extends [ChangelogConfig](https://github.com/unjs/changelogen#configuration) from changelogen with additional monorepo-specific options.
-
-#### `types`
-
-**Type:** `Record<string, { title: string, semver?: 'major' | 'minor' | 'patch' } | false>`
-
-**Description:** Defines commit types and their impact on versioning.
-
-- With `semver`: Triggers a version bump
-  - `'major'`: Breaking changes → 1.0.0 → 2.0.0
-  - `'minor'`: New features → 1.0.0 → 1.1.0
-  - `'patch'`: Bug fixes → 1.0.0 → 1.0.1
-- Without `semver`: Appears in changelog but doesn't trigger a bump
-- `false`: Completely ignored (no changelog, no bump)
-
-**Example:**
-
-```typescript
-export default defineConfig({
-  types: {
-    // Trigger a bump
-    feat: { title: '🚀 Features', semver: 'minor' },
-    fix: { title: '🩹 Fixes', semver: 'patch' },
-    perf: { title: '🔥 Performance', semver: 'patch' },
-
-    // Appear in changelog but no bump
-    docs: { title: '📖 Documentation' },
-    chore: { title: '🏡 Chore' },
-
-    // Completely ignored
-    ci: false,
-    test: false,
-  },
-})
-```
-
-#### `monorepo`
-
-Monorepo-specific configuration (required).
-
-| Property             | Type                                            | Default          | Description                              |
-| -------------------- | ----------------------------------------------- | ---------------- | ---------------------------------------- |
-| `versionMode`        | `'unified'` \| `'selective'` \| `'independent'` | `'selective'`    | How versions are managed across packages |
-| `packages`           | `string[]`                                      | `['packages/*']` | Glob patterns to locate packages         |
-| `ignorePackageNames` | `string[]`                                      | `[]`             | Package names to ignore                  |
-
-**Version modes:**
-
-| Mode               | Version     | Scope                      | Root & Lerna | Best for                       |
-| ------------------ | ----------- | -------------------------- | ------------ | ------------------------------ |
-| **`selective`** ⭐ | Unified     | Only packages with commits | ✅ Updated   | Most monorepos                 |
-| **`unified`**      | Unified     | ALL packages               | ✅ Updated   | Keep all packages synchronized |
-| **`independent`**  | Independent | Only packages with commits | ❌ Unchanged | Collections of unrelated tools |
-
-**Examples:**
-
-```typescript
-export default defineConfig({
-  // Selective mode (recommended) - Only bump packages with commits
-  monorepo: {
-    versionMode: 'selective',
-    packages: ['packages/*'],
-  },
-
-  // Unified mode - Bump ALL packages together
-  // monorepo: {
-  //   versionMode: 'unified',
-  //   packages: ['packages/*', 'tools/*'],
-  // },
-
-  // Independent mode - Each package has its own version
-  // monorepo: {
-  //   versionMode: 'independent',
-  //   packages: ['packages/*'],
-  //   ignorePackageNames: ['@myorg/internal-utils'],
-  // },
-})
+relizy release --prerelease --preid beta
 ```
 
-#### `changelog`
-
-Changelog generation configuration.
+Creates beta versions like 1.0.0-beta.0 for testing before stable releases.
 
-| Property            | Type      | Default     | Description                                        |
-| ------------------- | --------- | ----------- | -------------------------------------------------- |
-| `formatCmd`         | `string`  | `undefined` | Command to format changelogs after generation      |
-| `rootChangelog`     | `boolean` | `true`      | Generate root CHANGELOG.md with aggregated changes |
-| `includeCommitBody` | `boolean` | `false`     | Include full commit bodies in changelog entries    |
-
-**Example:**
-
-```typescript
-export default defineConfig({
-  changelog: {
-    formatCmd: 'pnpm lint:fix',
-    rootChangelog: true,
-    includeCommitBody: true,
-  },
-})
-```
-
-#### `bump`
-
-Version bump configuration.
-
-| Property          | Type                                                                        | Default            | Description                                             |
-| ----------------- | --------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------- |
-| `type`            | `'release'` \| `'major'` \| `'minor'` \| `'patch'` \| `'prerelease'` \| ... | `'release'`        | Default bump type ('release' auto-detects from commits) |
-| `preid`           | `string`                                                                    | `undefined`        | Pre-release identifier (alpha, beta, rc, etc.)          |
-| `clean`           | `boolean`                                                                   | `true`             | Check if working directory is clean before bumping      |
-| `dependencyTypes` | `Array<'dependencies' \| 'devDependencies' \| 'peerDependencies'>`          | `['dependencies']` | Which dependency types trigger a version bump           |
-| `yes`             | `boolean`                                                                   | `true`             | Skip confirmation prompt                                |
-
-**Dependency types:** When a package is updated, this decides which dependent packages should also be bumped:
-
-- `dependencies` - Packages that need it to work
-- `devDependencies` - Packages that need it for building/testing
-- `peerDependencies` - Packages that work alongside it
-
-**Example:**
-
-```typescript
-export default defineConfig({
-  bump: {
-    type: 'release',
-    dependencyTypes: ['dependencies', 'devDependencies'],
-    clean: true,
-    yes: true,
-  },
-})
-```
-
-#### `publish`
-
-npm publishing configuration.
-
-| Property   | Type                         | Default     | Description                                         |
-| ---------- | ---------------------------- | ----------- | --------------------------------------------------- |
-| `private`  | `boolean`                    | `false`     | Don't publish packages                              |
-| `tag`      | `string`                     | `'latest'`  | npm tag (auto: 'latest' for stable, 'next' for pre) |
-| `registry` | `string`                     | `undefined` | Custom registry URL                                 |
-| `access`   | `'public'` \| `'restricted'` | `undefined` | Package access level                                |
-| `otp`      | `string`                     | `undefined` | One-time password for 2FA                           |
-| `buildCmd` | `string`                     | `undefined` | Command to build packages before publish            |
-| `args`     | `string[]`                   | `[]`        | Additional arguments for publish command            |
-
-**Example:**
-
-```typescript
-export default defineConfig({
-  publish: {
-    private: false,
-    tag: 'latest',
-    registry: 'https://registry.npmjs.org',
-    access: 'public',
-    buildCmd: 'pnpm build',
-  },
-})
-```
-
-#### `release`
-
-Release workflow configuration.
-
-| Property    | Type      | Default | Description                         |
-| ----------- | --------- | ------- | ----------------------------------- |
-| `commit`    | `boolean` | `true`  | Commit changes and create tag       |
-| `push`      | `boolean` | `true`  | Push changes and tags to remote     |
-| `changelog` | `boolean` | `true`  | Generate changelog files            |
-| `release`   | `boolean` | `true`  | Create release on GitHub/GitLab     |
-| `publish`   | `boolean` | `true`  | Publish to npm                      |
-| `clean`     | `boolean` | `true`  | Check if working directory is clean |
-| `noVerify`  | `boolean` | `false` | Skip git hooks during commit        |
-| `force`     | `boolean` | `false` | Force bump even without commits     |
-
-**Example:**
-
-```typescript
-export default defineConfig({
-  release: {
-    commit: true,
-    push: true,
-    changelog: true,
-    release: true,
-    publish: true,
-    noVerify: false,
-  },
-})
-```
-
-#### `repo`
-
-Git repository configuration (auto-detected by default).
-
-| Property   | Type                     | Default       | Description                            |
-| ---------- | ------------------------ | ------------- | -------------------------------------- |
-| `provider` | `'github'` \| `'gitlab'` | Auto-detected | Git provider (auto from remote URL)    |
-| `domain`   | `string`                 | `undefined`   | Custom domain for self-hosted instance |
-| `repo`     | `string`                 | Auto-detected | Repository in 'owner/repo' format      |
-| `token`    | `string`                 | From env vars | Authentication token                   |
-
-**Auto-detection:**
-
-- Provider: Detected from git remote URL (github.com → GitHub, gitlab.com → GitLab)
-- Repository: Parsed from git remote URL
-- Token: Read from environment variables (see [tokens](#tokens) section)
-
-**Example:**
-
-```typescript
-export default defineConfig({
-  // For self-hosted GitLab
-  repo: {
-    provider: 'gitlab',
-    domain: 'gitlab.mycompany.com',
-  },
-})
-```
-
-#### `tokens`
-
-Authentication tokens for git providers (read from environment variables by default).
-
-| Property | Type     | Default       | Description                 |
-| -------- | -------- | ------------- | --------------------------- |
-| `github` | `string` | From env vars | GitHub authentication token |
-| `gitlab` | `string` | From env vars | GitLab authentication token |
-
-**Environment variables checked (in order):**
-
-- GitHub: `RELIZY_GITHUB_TOKEN`, `GITHUB_TOKEN`, `GH_TOKEN`
-- GitLab: `RELIZY_GITLAB_TOKEN`, `GITLAB_TOKEN`, `GITLAB_API_TOKEN`, `CI_JOB_TOKEN`
-
-**Example:**
-
-```typescript
-export default defineConfig({
-  tokens: {
-    github: process.env.GITHUB_TOKEN,
-    gitlab: process.env.GITLAB_TOKEN,
-  },
-})
-```
-
-#### `templates`
-
-Templates for commit and tag messages.
-
-| Property                | Type     | Default                                            | Description                                 |
-| ----------------------- | -------- | -------------------------------------------------- | ------------------------------------------- |
-| `commitMessage`         | `string` | `'chore(release): bump version to {{newVersion}}'` | Commit message template                     |
-| `tagMessage`            | `string` | `'Bump version to v{{newVersion}}'`                | Git tag message template                    |
-| `tagBody`               | `string` | `'v{{newVersion}}'`                                | Git tag body (not used in independent mode) |
-| `emptyChangelogContent` | `string` | `'No relevant changes for this release'`           | Changelog content when no changes           |
-
-**Available variables:** `{{newVersion}}`, `{{oldVersion}}`, `{{packageName}}`
-
-**Example:**
-
-```typescript
-export default defineConfig({
-  templates: {
-    commitMessage: 'chore(release): v{{newVersion}} [skip ci]',
-    tagMessage: 'Release {{newVersion}}',
-    tagBody: 'Version {{newVersion}}',
-  },
-})
-```
-
-#### `logLevel`
-
-Control verbosity of command output.
-
-**Type:** `'silent' | 'error' | 'warning' | 'normal' | 'default' | 'debug' | 'trace' | 'verbose'`
-
-**Default:** `'default'`
-
-See [Log Level](#log-level) section for details.
-
-#### Inherited from Changelogen
-
-The following options are inherited from [changelogen configuration](https://github.com/unjs/changelogen#configuration):
-
-| Property         | Type                     | Default         | Description                               |
-| ---------------- | ------------------------ | --------------- | ----------------------------------------- |
-| `cwd`            | `string`                 | `process.cwd()` | Working directory                         |
-| `from`           | `string`                 | Last git tag    | Start reference for changelog             |
-| `to`             | `string`                 | `HEAD`          | End reference for changelog               |
-| `excludeAuthors` | `string[]`               | `[]`            | List of authors to exclude from changelog |
-| `noAuthors`      | `boolean`                | `false`         | Don't include authors in changelog        |
-| `scopeMap`       | `Record<string, string>` | `{}`            | Map scopes to custom names                |
-
-**Example:**
-
-```typescript
-export default defineConfig({
-  cwd: process.cwd(),
-  from: 'v1.0.0',
-  to: 'HEAD',
-  excludeAuthors: ['bot[bot]', 'dependabot'],
-  noAuthors: false,
-  scopeMap: {
-    ui: 'User Interface',
-    api: 'API',
-  },
-})
-```
-
-### Configuration Examples
-
-#### Simple configuration (selective mode)
-
-```typescript
-import { defineConfig } from 'relizy'
-
-export default defineConfig({
-  types: {
-    feat: { title: '🚀 Features', semver: 'minor' },
-    fix: { title: '🩹 Fixes', semver: 'patch' },
-  },
-  monorepo: {
-    versionMode: 'selective',
-    packages: ['packages/*'],
-  },
-})
-```
-
-#### Advanced configuration
-
-```typescript
-import { defineConfig } from 'relizy'
-
-export default defineConfig({
-  types: {
-    feat: { title: '🚀 Features', semver: 'minor' },
-    fix: { title: '🩹 Fixes', semver: 'patch' },
-    perf: { title: '🔥 Performance', semver: 'patch' },
-    docs: { title: '📖 Documentation' },
-    chore: { title: '🏡 Chore' },
-    ci: false,
-    test: false,
-  },
-
-  monorepo: {
-    versionMode: 'selective',
-    packages: ['packages/*', 'tools/*'],
-    ignorePackageNames: ['@myorg/eslint-config'],
-  },
-
-  changelog: {
-    formatCmd: 'pnpm lint:fix',
-    rootChangelog: true,
-  },
-
-  bump: {
-    type: 'release',
-  },
-
-  publish: {
-    private: false,
-    tag: 'latest',
-  },
-
-  release: {
-    push: true,
-    release: true,
-    publish: true,
-    noVerify: false,
-  },
-
-  templates: {
-    commitMessage: 'chore(release): v{{newVersion}}',
-  },
-})
-```
-
-#### Configuration for self-hosted GitLab
-
-```typescript
-import { defineConfig } from 'relizy'
-
-export default defineConfig({
-  repo: {
-    domain: 'gitlab.mycompany.com',
-    provider: 'gitlab',
-  },
-  monorepo: {
-    versionMode: 'selective',
-    packages: ['packages/*'],
-  },
-})
-```
-
-## 📁 Multiple Configuration Files
-
-You can create multiple configuration files to manage different release workflows in your monorepo. This is useful when you have packages with different versioning strategies or release cadences.
-
-### Use Cases
-
-**Common scenarios for multiple configs:**
-
-1. **Separate core packages from standalone utilities** - Core UI packages use `selective` mode together, while standalone utilities use `independent` mode
-2. **Different release cadences** - Stable packages vs experimental packages
-3. **Different registries** - Public npm vs private registry
-4. **Different package groups** - Apps vs libraries vs tools
-
-### How to Create Multiple Configs
-
-Create multiple configuration files following this naming pattern: `<name>.config.<ext>`
-
-**Example file structure:**
-
-```text
-/
-├── relizy.config.ts              # Main config (core packages)
-├── relizy.standalone.config.ts   # Standalone utilities config
-└── relizy.experimental.config.json # Experimental packages config
-```
-
-You can use any supported format (`.ts`, `.js`, `.json`, `.yaml`, etc.) for each config file.
-
-### Example: Core UI Packages vs Standalone Utilities
-
-This is a real-world example where you want to separate UI components (which should be released together) from standalone utilities (which can evolve independently).
-
-**`relizy.config.ts`** - Core UI packages (selective mode):
-
-```typescript
-import { defineConfig } from 'relizy'
-
-export default defineConfig({
-  types: {
-    feat: { title: '🚀 Features', semver: 'minor' },
-    fix: { title: '🩹 Fixes', semver: 'patch' },
-  },
-  monorepo: {
-    versionMode: 'selective',
-    packages: [
-      'packages/lib',
-      'packages/icons',
-      'packages/themes',
-      'packages/nuxt',
-      'packages/translations',
-    ],
-  },
-  templates: {
-    commitMessage: 'chore(release): v{{newVersion}}',
-  },
-})
-```
-
-**`relizy.standalone.config.ts`** - Standalone utilities (independent mode):
-
-```typescript
-import { defineConfig } from 'relizy'
-
-export default defineConfig({
-  types: {
-    feat: { title: '🚀 Features', semver: 'minor' },
-    fix: { title: '🩹 Fixes', semver: 'patch' },
-  },
-  monorepo: {
-    versionMode: 'independent',
-    packages: [
-      'packages/utils',
-      'packages/node',
-      'packages/changelogen-monorepo',
-      'packages/eslint-config',
-    ],
-  },
-  templates: {
-    commitMessage: 'chore(release): {{packageName}}@{{newVersion}}',
-  },
-  changelog: {
-    rootChangelog: false, // No root changelog for independent packages
-  },
-})
-```
-
-### Usage with Multiple Configs
+### Control What Runs
 
 ```bash
-# Release core UI packages together (selective mode)
-pnpm relizy release --patch
-# or explicitly
-pnpm relizy release --config relizy --patch
-
-# Release standalone utilities independently
-pnpm relizy release --config relizy.standalone --patch
-
-# You can also use different configs for different commands
-pnpm relizy bump --config relizy.standalone --minor
-pnpm relizy changelog --config relizy.standalone
-pnpm relizy publish --config relizy.standalone
-```
-
-### Example: Different Registries
-
-**`relizy.config.ts`** - Public packages (npm registry):
-
-```typescript
-import { defineConfig } from 'relizy'
-
-export default defineConfig({
-  monorepo: {
-    versionMode: 'selective',
-    packages: ['packages/public/*'],
-  },
-  publish: {
-    registry: 'https://registry.npmjs.org',
-    access: 'public',
-  },
-})
-```
-
-**`relizy.private.config.ts`** - Private packages (GitHub Packages):
-
-```typescript
-import { defineConfig } from 'relizy'
-
-export default defineConfig({
-  monorepo: {
-    versionMode: 'independent',
-    packages: ['packages/private/*'],
-  },
-  publish: {
-    registry: 'https://npm.pkg.github.com',
-    access: 'restricted',
-  },
-})
-```
+# Skip git push
+relizy release --patch --no-push
 
-```bash
-# Publish public packages to npm
-pnpm relizy publish
+# Skip GitHub/GitLab release
+relizy release --patch --no-provider-release
 
-# Publish private packages to GitHub Packages
-pnpm relizy publish --config relizy.private
+# Just bump and commit
+relizy release --patch --no-publish --no-push
 ```
 
-### Best Practices
-
-1. **Use descriptive config names** - `relizy.standalone.config.ts` is better than `relizy.alt.config.ts`
-2. **Document your workflow** - Add comments in your config files explaining the purpose
-3. **Keep it simple** - Don't create too many configs unless necessary
-4. **Version control** - Commit all config files to your repository
-5. **CI/CD integration** - Use different configs in different CI jobs if needed
-
-### Tips
-
-- The default config is `relizy.config.<ext>` where c12 will auto-detect the extension (you don't need `--config` flag)
-- Config files must follow the pattern `<name>.config.<ext>` (c12 requirement)
-- Supported formats: `.ts`, `.js`, `.mjs`, `.cjs`, `.mts`, `.cts`, `.json`, `.jsonc`, `.json5`, `.yaml`, `.yml`, `.toml`
-- All commands support the `--config` option
-- You can combine `--config` with `--dry-run` to preview different workflows
-
-## 🔗 Dependency Management
+For detailed CLI reference, configuration options, and advanced features, check out the [full documentation](https://louismazel.github.io/relizy/).
 
-The tool automatically detects and bumps packages that depend on other packages in the monorepo.
+## 🧑‍💻 Development & Contributing
 
-### How it works
-
-**Automatic detection:**
-
-- When package B is updated, all packages that depend on B are automatically identified
-- By default only `dependencies` are considered (not `devDependencies` or `peerDependencies`). You can change this behavior using the [dependencyTypes](#bump) option.
-- Transitive dependencies are handled: if A→B→C and C is updated, both B and A are bumped
-
-**Bump types by mode:**
-
-- **Selective/unified mode:** Dependent packages get the same unified version as the root
-- **Independent mode:** Dependent packages get a minimum `patch` bump (can be higher if they also have commits)
-
-**Example:**
+### Running Tests
 
 ```bash
-Packages:
-  - @maz-ui/utils@1.0.0
-  - @maz-ui/components@2.0.0 (depends on @maz-ui/utils)
-  - @maz-ui/forms@1.5.0 (depends on @maz-ui/components)
-
-Commit: feat(utils): add new utility
+# Run all tests
+pnpm test:unit
 
-Result in Independent mode:
-  - @maz-ui/utils: 1.0.0 → 1.1.0 (minor - from commit)
-  - @maz-ui/components: 2.0.0 → 2.0.1 (patch - dependency updated)
-  - @maz-ui/forms: 1.5.0 → 1.5.1 (patch - transitive dependency)
+# Run tests in watch mode
+pnpm test:unit:watch
 
-Result in Selective mode:
-  - All 3 packages: bumped to unified version 2.1.0
-  - Root version: 2.0.0 → 2.1.0
+# Run tests with coverage
+pnpm test:unit:coverage
 ```
 
-## 🔄 Lerna Integration
+### Code Coverage
 
-### Automatic `lerna.json` updates
+This project uses [Codecov](https://codecov.io) to track code coverage. Coverage reports are automatically generated and uploaded when you push to `main` or `develop` branches, or when you create a pull request.
 
-If a `lerna.json` file exists at the root, the tool automatically updates its `version` field during bump (in unified and selective modes only).
+**Coverage Requirements:**
 
-**No `lerna.json`?** No problem! The tool works perfectly without it.
+- **Overall project**: Coverage should not decrease by more than 0.5%
+- **New code (patches)**: Must have at least 80% coverage
 
-### Replacing Lerna commands
+You can view detailed coverage reports on [Codecov](https://codecov.io/gh/LouisMazel/relizy).
 
-| Lerna command                           | relizy equivalent                          |
-| --------------------------------------- | ------------------------------------------ |
-| `lerna version patch`                   | `relizy release --patch`                   |
-| `lerna version minor`                   | `relizy release --minor`                   |
-| `lerna version major`                   | `relizy release --major`                   |
-| `lerna version prerelease --preid beta` | `relizy release --prerelease --preid beta` |
-| `lerna publish from-package`            | Not needed (use `pnpm publish -r`)         |
-
-### Migration from Lerna
-
-1. Keep your existing `lerna.json` (optional)
-2. Create a `relizy.config.ts` with your versioning strategy
-3. Replace `lerna version` with `relizy release`
-4. Use your package manager to publish (e.g., `pnpm publish -r`)
-
-## 🦊 GitLab CI/CD Configuration
-
-### Personal Access Token
-
-1. Go to GitLab → Settings → Access Tokens
-2. Create a token with `api` scope
-3. Set the environment variable:
+To see coverage locally:
 
 ```bash
-RELIZY_GITLAB_TOKEN="your-token-here"
-```
-
-### CI/CD Pipeline
-
-GitLab CI automatically provides `CI_JOB_TOKEN` which can be used for releases:
-
-```yaml
-release:
-  stage: deploy
-  script:
-    - pnpm install
-    - pnpm relizy release --yes
-  only:
-    - main
+pnpm test:unit:coverage
+# Open coverage/index.html in your browser
 ```
 
-## Programmatic Usage (API)
-
-You can also use the tool programmatically:
-
-```typescript
-import {
-  bump,
-  changelog,
-  providerRelease,
-  publish,
-  release,
-} from 'relizy'
-
-// Bump versions
-await bump({
-  type: 'prerelease',
-  preid: 'beta',
-})
+### Pull Request Guidelines
 
-// Generate changelogs
-await changelog({
-  from: 'v1.0.0',
-  to: 'v1.1.0',
-})
+When submitting a PR:
 
-// Publish to npm
-await publish({
-  registry: 'https://registry.npmjs.org',
-  tag: 'beta',
-})
+1. Ensure all tests pass (`pnpm test:unit`)
+2. Check TypeScript types (`pnpm typecheck`)
+3. Lint your code (`pnpm lint`)
+4. Add tests for new features
+5. Maintain or improve code coverage (Codecov will comment on your PR)
 
-// GitHub release
-// Git provider is detected automatically but you can also specify it explicitly
-await providerRelease({
-  provider: 'github',
-})
+The Codecov bot will automatically comment on your PR with coverage details and changes.
 
-// Complete workflow
-await release({
-  type: 'prerelease',
-  preid: 'beta',
-  tag: 'beta',
-  registry: 'https://registry.npmjs.org',
-  push: true,
-  release: true,
-  publish: true,
-})
-```
+For detailed contribution guidelines, including development setup, testing workflows, commit conventions, and the complete PR process, please read our **[Contributing Guide](CONTRIBUTING.md)**.
 
 ## License