Semantic release configuration for LobeHub projects

Features

• Gitmoji commit convention
• Automated versioning and changelog
• GitHub releases
• NPM publishing
• Monorepo support

Installation

pnpm add -D @lobehub/semantic-release-config semantic-release

Usage

Standard Project

Create .releaserc.js in your project root:

import config from '@lobehub/semantic-release-config';

export default config;

Monorepo

import config from '@lobehub/semantic-release-config/monorepo';

export default config;

Changelog Only

For generating changelog without releasing:

import config from '@lobehub/semantic-release-config/changelog';

export default config;

Exports

| Export | Description | | -------------------------------------------- | ------------------------- | | @lobehub/semantic-release-config | Standard release config | | @lobehub/semantic-release-config/monorepo | Monorepo release config | | @lobehub/semantic-release-config/changelog | Changelog generation only |

GitHub Actions

name: Release

on:
  push:
    branches: [master, main]

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - uses: pnpm/action-setup@v2

      - uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: pnpm

      - run: pnpm install --frozen-lockfile

      - run: pnpm build

      - name: Release
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
        run: pnpm semantic-release

Extending

import config, { options } from '@lobehub/semantic-release-config';

export default {
  ...config,
  branches: ['main', 'next'],
};

Requirements

• Node.js >= 18
• semantic-release >= 21.0.0

License

MIT © LobeHub