Releaser.Commits (releaser v0.0.2)

Copy Markdown View Source

Reads Conventional Commits from git log and produces a per-app bump plan.

Inputs

  • since — git ref to use as the lower bound (last release tag, etc.). When nil, auto-detected from the most recent v* tag, falling back to the full history.
  • config — the :commits section of Releaser.Config.load/0 (bump_rules, breaking_bump, breaking_markers, scope_aliases, no_scope).
  • apps — list of %Releaser.App{} from Releaser.Workspace.discover/1.

Output

A list of %{app: name, bump: :major | :minor | :patch, commits: [Commit.t()]} for each app that receives a bump. Apps with no relevant commits are omitted entirely — callers should treat missing apps as "no bump".

Breaking detection

A commit is breaking if any of the configured breaking_markers applies:

  • :bang — feat(xml)!: subject
  • :body — BREAKING CHANGE: or BREAKING-CHANGE: in the body

Breaking commits always use breaking_bump (default :major) regardless of type.

Aggregation

For each app, the highest bump among relevant commits wins: major > minor > patch > none. No summation — 10 feat commits still produce a single :minor bump.

Summary

Types

bump()
commit()
plan_entry()

Functions

detect_last_tag()

Returns the most recent tag matching v*, or nil when there is none.

parse_log(raw, config)

Parses the raw output of git log (with @log_separator) into a list of commit maps. Exposed for testing.

plan(opts \\ [])

Returns a list of plan entries for apps that should bump.

read_git_log(since)

Reads git log <range> --format=... and returns raw output. Exposed so tests can replace it with a fixture.

Types

bump()

@type bump() :: :major | :minor | :patch | :none

commit()

@type commit() :: %{
  sha: String.t(),
  type: String.t(),
  scope: String.t() | nil,
  subject: String.t(),
  body: String.t(),
  breaking: boolean(),
  bump: bump()
}

plan_entry()

@type plan_entry() :: %{
  app: String.t(),
  bump: :major | :minor | :patch,
  commits: [commit()]
}

Functions

detect_last_tag()

@spec detect_last_tag() :: String.t() | nil

Returns the most recent tag matching v*, or nil when there is none.

parse_log(raw, config)

@spec parse_log(String.t(), map()) :: [commit()]

Parses the raw output of git log (with @log_separator) into a list of commit maps. Exposed for testing.

plan(opts \\ [])

@spec plan(keyword()) :: [plan_entry()]

Returns a list of plan entries for apps that should bump.

When no commits are relevant (or --since resolves to HEAD), returns [].

read_git_log(since)

@spec read_git_log(String.t() | nil) :: String.t()

Reads git log <range> --format=... and returns raw output. Exposed so tests can replace it with a fixture.