Notorious Party Muppets

    @jeromefitz/semantic
    TypeScript icon, indicating that this package has built-in type declarations

    9.1.0 • Public • Published

    @jeromefitz/semantic

    Overview

    Installation

    yarn add @jeromefitz/semantic --dev

    This extends @jeromefitz/git-cz.

    Semantic Release

    ./release.config.cjs

    Custom values:

    • enableGit?: boolean
    • enableGithub?: boolean
    • enableNpm?: boolean
    • enableReleaseNotes?: boolean
    • enableReleaseNotesCustom?: boolean

    And then the rest of the traditional configuration values for semantic-release and conventional-changelog.

    Example

    You can look at this monorepo as it re-uses a lot of code ethroughout via release.config

    const { getConfig } = require('@jeromefitz/semantic')
    
    const { name } = require('./package.json')
    
    const configPassed = {
      tagFormat: `${name}@\${version}`,
    }
    
    const config = getConfig(configPassed)
    
    module.exports = config

    Scripts

    Branch Names

    Add a script in package.json:

      "scripts": {
        "branch": "git-cz --branch --allow-empty"
      }

    Running yarn branch will then trigger the CLI to create branch for you based on

    CI/CD

    Add a script in package.json as this extends semantic-release:

      "scripts": {
        "semantic-release": "semantic-release"
      }

    Be sure to allow for Git + GitHub access so semantic-release can create commits and more actions on your repo.

    Configured in this repo via ./github/workflows/semantic-release.yml.

    Keywords

    none

    Install

    npm i @jeromefitz/semantic

    DownloadsWeekly Downloads

    501

    Version

    9.1.0

    License

    MIT

    Unpacked Size

    129 kB

    Total Files

    12

    Last publish

    Collaborators

    • jeromefitz