@yikoyu/semantic-release-config

➡️ Extendable semantic-release configuration, part of the yikoyu/unconfig project.

---

Prerequisites

ℹ️ This configuration package require these tools to use locally on your device(s):

1. Latest Node.js LTS (Long-Term Support) version
2. One of Node.js package managers:
   • pnpm
   • yarn
   • npm
3. Latest semantic-release version

---

Basic usage

👣 Follow the steps below:

1. Install it with the Node.js package manager of your choice (in our case, we use pnpm).

    pnpm install --save-dev semantic-release @yikoyu/semantic-release-config conventional-changelog-conventionalcommits

2. If using pnpm, please add configuration to the .npmrc file.

   public-hoist-pattern[]=@semantic-release/*
   

3. Create a semantic-release configuration file - release.config.(js|cjs|.mjs).

4. Extend this module package configuration.

   import { yikoyu } from '@yikoyu/semantic-release-config'
   
   export default yikoyu()

📖 For the usage, please refer to its documentation.

---

Used configurations & plugins

⚙️ This configuration module for semantic-release loads configurations and plugins options conditionally.

Configurations

Configurations	Version	Loading condition(s)
@semantic-release/changelog		-
@semantic-release/commit-analyzer		-
@semantic-release/git		-
@semantic-release/github		-
@semantic-release/npm		-
@semantic-release/release-notes-generator		-
conventional-changelog-conventionalcommits		commit preset

License

⚖️ For more information, please refer to the License section at the root of the yikoyu/unconfig monorepo.