Skip to content

Release Configuration

Configure release workflow behavior.

commit

Enable/disable git commits:

ts
import { defineConfig } from 'relizy'

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

push

Enable/disable git push of commit and tags:

ts
import { defineConfig } from 'relizy'

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

changelog

Enable/disable changelog generation:

ts
import { defineConfig } from 'relizy'

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

clean

Enable/disable git clean:

ts
import { defineConfig } from 'relizy'

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

noVerify

Enable/disable git --no-verify flag:

ts
import { defineConfig } from 'relizy'

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

publish

Enable/disable npm publish:

ts
import { defineConfig } from 'relizy'

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

gitTag

Enable/disable git tag push:

ts
import { defineConfig } from 'relizy'

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

providerRelease

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

ts
import { defineConfig } from 'relizy'

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

social

Enable/disable social media posting:

ts
import { defineConfig } from 'relizy'

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

See Social Media Integration for more details.

Complete Example

ts
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,
  },
})

Released under the MIT License.