chlog.core

Changelog aggregation, specification, validation, and webpage generation.

Options map key-vals:

  • :project-formatted-filename
  • :copyright-holder
  • :changelog-UUID
  • :changelog-html-directory
  • :changelog-html-filename
  • :changelog-markdown-directory
  • :changelog-markdown-filename
  • :changelog-entries-directory
  • :changelog-policies-section (optional)

-main

(-main & options-filename)

Generate an html and a markdown changelog, sourcing options from file options-filename if supplied, otherwise resources/chlog_options.edn.

Examples:

;; generate changelog using options from 'resources/chlog_options.edn'
(-main)

;; generate changelog using options from 'other_directory/custom_changelog_opt.edn'
(-main "other_directory/custom_changelog_opt.edn")

From the command line, options file defaults to resources/chlog_options.edn:

$ lein run -m chlog.core

From the command line, explicit options file other_directory/custom_changelog_opt.edn:

$ lein run -m chlog.core other_directory/custom_changelog_opt.edn

chlog-defaults

A hash-map residing in chlog_defaults.clj that supplies the default values for the following options keys:

  • :changelog-html-directory
  • :changelog-html-filename
  • :changelog-markdown-directory
  • :changelog-markdown-filename
  • :changelog-entries-directory
  • :changelog-data-file
  • :changelog-policies-section
  • :tidy-html?

Override default values by associating new values into the Chlog options hash-map. See generate-all-changelogs.

generate-all-changelogs

(generate-all-changelogs opt)

Given Chlog options opt, write-to-file html and markdown changeloges.

See project documentation for details on the structure of the options map.

Changelog data will be read from resources/changelog_entries/changelog.edn unless superseded by :changelog-entries-directory or :changelog-data-file values in the options map.

Defaults supplied by src/chlog_defaults.edn