Skip to content
Logmarq documentation contents
Logmarq documentation

Release notes

Internal notes drafted from the changes, customer notes as a checked subset, and where they go.

Release notes

Logmarq turns each release's changes into notes: internal notes for the team, and customer notes that say what changed for the people who use the release.

Internal notes

Every release gets internal notes drafted from its changes as it is recorded. Each item keeps the pull requests and issues it came from, so anyone can open the work behind a line. Approve a draft that is right as it stands, or edit it. Every save is a new version.

Drafting uses a template unless you configure a model. The template works from pull request titles and labels and needs nothing external. A model is optional: Claude through the Anthropic API, or any server that speaks the OpenAI chat-completions format, including one you run locally. You choose and pay for the model; Logmarq sends it the release's changes when asked to draft.

Customer notes

Customer notes are made from the internal items you tick as customer visible, rewritten in the voice you configure or kept as you wrote them. Logmarq refuses customer notes that are not a subset of the visible internal items, so nothing internal reaches a customer by accident. A project can keep customer notes in other languages, each checked item for item against the notes it was translated from.

A single customer can have its own customer notes, with more detail than the general ones, seen only by the people granted that customer. Public notes, for anyone to read, are the same shape and held to the same check.

Where notes go

  • Copy as Markdown, plain text, or rich text, for a chat, an email, or a wiki.
  • Export as Markdown or HTML.
  • Publish as the body of the release on your git host. This is an explicit act, and it needs a permission you grant the GitHub App yourself.
  • A public page per project, when you turn it on, lists released versions with their customer or public notes.

What notes will not do

  • Logmarq never publishes or sends notes on its own. Drafting is automatic; sharing is yours.
  • A draft is a draft. The template summarizes titles and labels; it does not know what your customers care about until you tick it.

Release records · Customer-response packages