semantic-release

Appearance

On this page

Release config ​

Default config ​

The configuration for semantic-release must be placed in the release.config.js

js
const generateReleaseConfig = require('@lade-software-library/semantic-release/release/generate-config')

module.exports = generateReleaseConfig({
  // Optional list of additional semantic-release plugins  
  plugins: [],
  // Run `npm run build` after version has been changed (default: false)
  rebuildVersion: false,
  // Publish NPM package (default: false)
  publishPackage: false
})

Test the configuration without release ​

You can test the configuration or preview the new version by using the --dry-run option on the semantic-release command:

pnpm semantic-release --dry-run

Example with custom plugin ​

js
const generateReleaseConfig = require('@lade-software-library/semantic-release/release/generate-config')

module.exports = generateReleaseConfig({
  // Optional list of additional semantic-release plugins  
  plugins: [
     ['@semantic-release/exec', {
        // Do something before publish with new version tag
        prepareCmd: 'sh .build/build.sh ${nextRelease.version}'
     }]
  ],
   
  // ...
})