Conventional Commit Draft groups your subjects into release notes

Turn selected commit subjects into a release draft that you can review before saving.

MIT · no telemetry · core features free

The preview groups selected subjects under Features, Fixes and Documentation.
Open larger
version
1.1.0
released
downloads
20
review
Passed
health
Excellent
license
MIT
listed for
Desktop, Mobile
obsidian
1.13.4 or later

Tested on desktop only.

Directory facts fetched from community.obsidian.md/users/theluckystrike.

About Conventional Commit Draft

You keep commit subjects in project notes and need a draft before you prepare a release.

Select commit subjects in your Markdown editor and preview a grouped release draft. Save the result as a new note at the vault root. Your source note stays unchanged.

The command reads your selection through the editor API. It does not read a Git repository, choose a version number or publish a release.

Select preview and save workflowPlay demo

Free features

Selected subjects and grouped drafts

Select one subject per line. Recognized types get their own headings, and subjects keep their order within each type. Empty groups do not appear.

Hashes, scopes, and breaking subjects

The parser keeps an optional hexadecimal hash of 7 to 40 characters and the scope. A breaking mark in the subject adds a BREAKING label. The parser does not interpret commit bodies.

Other types and Review

Parsed types outside the default headings get an Other heading. Lines that do not parse stay under Review. Duplicate subjects stay in the draft.

Literal text and separate local saves

The preview shows Markdown source as text. The report escapes subject formatting and saves to a new note, with a numbered name if needed. A write error keeps the preview open.

The command accepts up to 2,000 nonblank selected lines; saved headings and named templates need Pro.

Pro features

Pro costs $5 a month or $15 one time through GitHub Sponsors. One sponsorship turns on Pro in every plugin that has it.

Project type names and heading order Pro

Save 1 to 30 unique lowercase types with heading names in settings. Their order sets the report order. Signing out restores the default headings for new drafts.

Named report templates Pro

Save up to 20 named templates with a release title and project name. Each template needs one {{sections}} slot and permits up to 10,000 characters. Check links and embeds in your template before use.

Set up Conventional Commit Draft

needs

  • Obsidian 1.13.4 or later

steps

  1. Open a Markdown note in an editable view and select one commit subject per line.

  2. Run Preview release draft from selection from the command palette.

  3. Check the groups, scopes, BREAKING labels and Review lines.

  4. Set a release title and project name, then select Save new draft.

  5. Open the new note from the file explorer.

If the app can't find a new plugin yet, try again later. Obsidian says a plugin that passes the review shows in the app within 24 hours.

How to draft release notes from commit subjects in Obsidian

Known limits of Conventional Commit Draft

  • Input stops at 2,000 nonblank lines.
  • Only a breaking mark in the commit subject produces the BREAKING label. Details in the commit body do not.
  • The GitHub sign-in token stays in memory when Obsidian secret storage is not available, so a restart needs a new sign-in.

Need a change for your team? I build custom Obsidian plugins and features.

Questions about Conventional Commit Draft

Does this command run Git?

No. It reads selected editor text and writes a Markdown note. Choose the subjects for your release before you run it.

Why did a subject go into Review?

The parser needs a type, an optional scope and breaking mark, then a colon, whitespace and subject text. Remove pasted bullets or log decorations if you want the line to parse.

Can I change the title without Pro?

Yes. The current draft title and project name are free. Pro adds saved project headings and named templates.

Where does the GitHub token stay?

The plugin uses Obsidian secret storage when that API is available. Without it, the token stays in memory until restart. The token does not enter saved plugin settings.

Network use

The plugin sends no requests before you sign in with GitHub. Sign-in sends device authorization data to github.com; sponsorship checks send your token and account query to api.github.com. Successful checks last 7 days, failed checks can retry after 6 hours, and no vault content enters these requests.

Read the full network disclosure

Questions or ideas?

Tell me what is broken in Conventional Commit Draft, or what it should do next.

Send feedback

Conventional Commit Draft 1.1.0, MIT license

MIT · no telemetry · core features free