← All releases

wp-content/plugins/cairn/cairn.php

Cairn — beta

Publish a changelog page from your actual commits, edited by a person.

== Description ==

Automatically generated changelogs read like a commit log because that is what they are, and users do not care that you bumped a dependency. Cairn drafts an entry from conventional commits between two tags and then stops, leaving a draft for a person to rewrite into something a reader benefits from.

Commits are grouped by type and each carries its hash, so an editor rewriting an entry can check what it actually did.

It reads from a repository you point it at over the API, or from a file your CI writes. Neither requires giving WordPress access to your source control.

== Screenshots ==

Numbered the way they ship in /assets/. Click any one to see it full width.

== Installation ==

  • Install and activate the plugin.
  • Point it at a repository, or have CI post a commit list to the endpoint.
  • Run wp cairn draft --from=v2.3.0 --to=v2.4.0.

It never publishes. Drafts are drafts, deliberately.

== Frequently asked questions ==

Which commit convention?

Conventional Commits by default, with a configurable pattern for anything else.

Does it need repository access?

Not necessarily. CI can post the commit list, which keeps credentials out of WordPress.

== Changelog ==

= 0.9.2 =

  • Commit hashes retained on each drafted line, so an editor can check what a change did before rewriting it.

= 1.0.0 =

  • First release.