Release Configuration

Configure release workflow behavior.

commit

Enable/disable git commits:

import { defineConfig } from 'relizy'

export default defineConfig({
  release: {
    commit: true,
  },
})

push

Enable/disable git push of commit and tags:

import { defineConfig } from 'relizy'

export default defineConfig({
  release: {
    push: true,
  },
})

changelog

Enable/disable changelog generation:

import { defineConfig } from 'relizy'

export default defineConfig({
  release: {
    changelog: true,
  },
})

clean

Enable/disable git clean:

import { defineConfig } from 'relizy'

export default defineConfig({
  release: {
    clean: true,
  },
})

noVerify

Enable/disable git --no-verify flag:

import { defineConfig } from 'relizy'

export default defineConfig({
  release: {
    noVerify: true,
  },
})

publish

Enable/disable npm publish:

import { defineConfig } from 'relizy'

export default defineConfig({
  release: {
    publish: true,
  },
})

gitTag

Enable/disable git tag push:

import { defineConfig } from 'relizy'

export default defineConfig({
  release: {
    gitTag: true,
  },
})

providerRelease

Enable/disable provider release creation (GitHub/GitLab):

import { defineConfig } from 'relizy'

export default defineConfig({
  release: {
    providerRelease: true,
  },
})

social

Enable/disable social media posting:

import { defineConfig } from 'relizy'

export default defineConfig({
  release: {
    social: true,
  },
})

See Social Media Integration for more details.

prComment

Enable/disable PR comment posting:

import { defineConfig } from 'relizy'

export default defineConfig({
  release: {
    prComment: true,
  },
})

See PR Comments for more details.

Canary Mode Behavior

When using relizy release --canary, several release options are automatically overridden regardless of your configuration:

Option	Forced to	Reason
commit	false	No git commit for a temporary version
push	false	Nothing to push (no commit, no tag)
changelog	false	No changelog for a temporary version
providerRelease	false	No GitHub/GitLab release for a test version
social	false	No social media announcement for a test version
gitTag	false	No tag for an ephemeral version

The following options are not affected by canary mode and respect your configuration:

• publish - Stays enabled (this is the main purpose of canary)
• prComment - Stays enabled (useful to see canary version in PRs)
• clean - Stays enabled (still checks for uncommitted changes)
• noVerify - Unchanged

See the Canary Releases guide for full details.

Complete Example

import { defineConfig } from 'relizy'

export default defineConfig({
  release: {
    commit: true,
    changelog: true,
    clean: true,
    noVerify: false,
    publish: true,
    providerRelease: true,
    push: true,
    gitTag: true,
    social: true,
    prComment: true,
  },
})