0.1.3 • Published 8 months ago

@yikoyu/semantic-release-config v0.1.3

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

@yikoyu/semantic-release-config

package version badge

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


Prerequisites

node.js version support badge supported semantic-release version badge

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

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

Basic usage

👣 Follow the steps below:

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

     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 icon - release.config.(js|cjs|.mjs).

  4. Extend this module package configuration.

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

📖 For the semantic-release icon usage, please refer to its documentation.


Used configurations & plugins

Dependencies badge

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

Configurations

ConfigurationsVersionLoading condition(s)
@semantic-release/changelog@semantic-release/changelog version badge-
@semantic-release/commit-analyzer@semantic-release/commit-analyzer version badge-
@semantic-release/git@semantic-release/git version badge-
@semantic-release/github@semantic-release/github version badge-
@semantic-release/npm@semantic-release/npm version badge-
@semantic-release/release-notes-generator@semantic-release/release-notes-generator version badge-
conventional-changelog-conventionalcommitsconventional-changelog-conventionalcommits version badgecommit preset

License

license badge

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