relizy / ReleaseConfig

Interface: ReleaseConfig

Defined in: src/types.ts:509

Extended by

• ReleaseOptions

Properties

changelog?

optional changelog: boolean

Defined in: src/types.ts:524

Generate changelog files (CHANGELOG.md)

Default

true

---

clean?

optional clean: boolean

Defined in: src/types.ts:544

Determine if the working directory is clean and if it is not clean, exit

Default

false

---

commit?

optional commit: boolean

Defined in: src/types.ts:514

Commit changes and create tag

Default

true

---

gitTag?

optional gitTag: boolean

Defined in: src/types.ts:549

Create tag

Default

true

---

noVerify?

optional noVerify: boolean

Defined in: src/types.ts:539

Skip git verification while committing by using --no-verify flag

Default

true

---

prComment?

optional prComment: boolean

Defined in: src/types.ts:559

Post release announcements to social media platforms

Default

false

---

providerRelease?

optional providerRelease: boolean

Defined in: src/types.ts:529

Publish release to your repository (github or gitlab)

Default

true

---

publish?

optional publish: boolean

Defined in: src/types.ts:534

Publish release to your registry

Default

true

---

push?

optional push: boolean

Defined in: src/types.ts:519

Push changes to your repository (commit and tag(s))

Default

true

---

social?

optional social: boolean

Defined in: src/types.ts:554

Post release announcements to social media platforms

Default

false