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

2.0.0 • Public • Published

@ygorluiz/semantic

Overview

Installation

yarn add @ygorluiz/semantic --dev

This extends @ygorluiz/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('@ygorluiz/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.

Readme

Keywords

none

Package Sidebar

Install

npm i @ygorluiz/semantic

Weekly Downloads

1

Version

2.0.0

License

MIT

Unpacked Size

20.3 kB

Total Files

12

Last publish

Collaborators

  • ygorneves