Changelogged.Options

Documentation

availableWarningFormats :: [WarningFormat]

availableWarningFormatsStr :: String

readWarningFormat :: ReadM WarningFormat

availableLevels :: [Level]

>>> availableLevels
[App,Major,Minor,Fix,Doc]

availableLevelsStr :: String

>>> availableLevelsStr
"(app major minor fix doc)"

readLevel :: ReadM Level

parser :: Parser Options

welcome :: Description

data Options

Constructors

Options

Fields

• optPackagesLevel :: Maybe Level

  Explicit level of changes for files with common versioning.

• optApiLevel :: Maybe Level

  Explicit level of changes in API.

• optFormat :: WarningFormat

  Output formatting.

• optWithAPI :: Bool

  Assume there is API to check and bump.

• optDifferentChlogs :: Bool

  Assume there is some changelogs with unpredicted meanings.

• optNoCheck :: Bool

  Do not check changelogs.

• optNoBump :: Bool

  Do not bump versions.

• optFromBC :: Bool

  Check changelogs from start of project.

• optForce :: Bool

  Bump versions even if changelogs are outdated.

• optWrite :: Bool

  Write suggestions to changelog directly.