Skip to main content
Introducing packages.sweber.dev
Documentation menuConfiguration

Configuration

derivative.config.json and CLI options.

derivative build reads derivative.config.json from the current directory, or the file given with --config. Paths in it are relative to the file. CLI options override it.

{
  "source": "changelog",
  "changelog": "CHANGELOG.md",
  "title": "Acme changelog",
  "link": "https://acme.ch/changelog",
  "limit": 30,
  "lang": "de",
  "out": {
    "json": "public/changelog.json",
    "atom": "public/changelog.xml",
    "jsonFeed": "public/feed.json",
    "html": "public/changelog.html"
  },
  "atomUrl": "https://acme.ch/changelog.xml",
  "jsonFeedUrl": "https://acme.ch/feed.json",
  "highlights": {}
}
KeyCLIDefaultMeaning
source--source (changelog, git, github, gitlab, linear, jira, notion)changelog if the file exists, else github if repo is set, else gitlab if project is set, else gitWhere releases come from
feedFormat--feed-format2Format of changelog.json; 1 for widgets still on 1.x
repo--repogithub: owner/name, uses GITHUB_TOKEN when set
linearlinear (beta): { "team": "ENG" } plus optional types, excludeLabels, fallback. Uses LINEAR_API_KEY
jirajira (beta): { "url": "https://acme.atlassian.net", "project": "ACME" } plus the same options and includeUnreleased. Uses JIRA_EMAIL and JIRA_API_TOKEN
notionnotion (beta): { "database": "<id>" } plus properties (names of the columns) and the same options. Uses NOTION_TOKEN
project--projectgitlab: project path (group/name) or numeric id, uses GITLAB_TOKEN when set
gitlabUrl--gitlab-urlhttps://gitlab.comgitlab: base URL of a self-managed instance
includePrereleases--prereleasesfalsegithub, gitlab: keep pre-releases (GitLab: upcoming releases)
packages--package (repeatable)allMonorepos: keep only these packages, a trailing * matches a prefix
excludePackages--exclude-package (repeatable)noneMonorepos: drop these packages, applied after packages
changelog--changelog (repeatable)CHANGELOG.mdOne path or a list for monorepos
tagPattern--tag-patterntags containing a versiongit: regular expression for release tags
typesfeat, fix, perf, security, deprecate, revertgit: commit type → entry type
commitUrl--commit-urlgit: link template, {hash} is replaced
includeUnreleased--unreleasedfalseKeep unreleased changes
title--titleFeed and page title
link--linkURL of the full changelog, used by the widget's "All changes" link
limit--limitallKeep the newest n releases
lang--langenLabels and dates in the Atom feed and HTML page
out.json--outpublic/changelog.json
out.atom--atomAtom feed
out.jsonFeed--json-feedJSON Feed 1.1, one item per release with HTML content
out.html--htmlStandalone HTML page
atomUrlPublic URL of the Atom file (its rel="self" link)
jsonFeedUrlPublic URL of the JSON Feed file (its feed_url)

derivative init writes a starting config for the current project: changelog as source if a CHANGELOG.md or .changeset folder exists, otherwise git, and changelog.json plus changelog.xml in public/ (or static/ for SvelteKit). | highlights | | | See Highlights |