DeployLog manual

02Entries

An entry is one item in a project's changelog: a title, a body, an optional type, and an optional version, the release number the change shipped in. Write it, save a draft, publish when it is true.

Write it

Start with the title. The field asks "What changed?".

The title is required and stops at 200 characters. The body is Markdown, the plain-text markup the public changelog renders, and it is required and capped at 50,000 characters. A version must be semver, three dot-separated numbers such as 1.2.3. Break one of those rules and the save is refused: the editor shows the reason in a red banner above the buttons, for example Must be valid semver (e.g. 1.2.3).

Type is one of five labels the changelog shows on an entry: Feature, Fix, Improvement, Breaking, Announcement. Pick "No type" when none of them fits.

Preview swaps the editor for the rendered body, and the same button then reads Editor.

Templates

A template is a starter body and type for a common kind of entry. The "Start from a template" row appears only on a new entry, before the first save.

Clicking a template sets the type. It replaces the body only when the body is empty or still holds the previous template's starter text so that you can switch templates freely; once you have written anything of your own, the template leaves the body untouched and changes only the type.

Generate with AI

Optional, and it overwrites what is in the form. A generation is one AI run over the text you paste. Paste raw release notes, or commit messages one per line, and add a version if you have one. The panel says so plainly: "Overwrites title, type, and body."

The counter beside the panel reads how many AI summaries you have used this month and how many are left; on Pro it reads "Unlimited AI summaries (Pro)". Chapter 07 covers the allowance, and chapter 12 the numbers per plan. When the month's allowance is gone, the generation is refused, the message appears in a red note under the Generate button, and the counter refreshes to the returned figures. Submit an empty box, and you get "Paste one commit message per line." instead of a request.

Save a draft

A draft is an entry that exists but is not on the public changelog. On a new entry, the button reads Save Draft; after the first save, it reads Save Changes. Saving a new entry opens that entry's own page, where the rest of the controls live. If a save fails, the red banner shows the reason and falls back to "Something went wrong".

The slug

The slug is the entry's name in its URL, and it is set from the title. The slug field does not exist until the first save.

After that first save, leave the field alone, and it keeps following the title, or type your own. A slug you type is capped at 200 characters, and a longer one is refused with the message in the red banner. Never count on editing a slug after publishing. Once the entry is published, the field becomes plain text marked "(locked after publishing)".

Publish and unpublish

Publish and Unpublish are one button that reads according to the entry's state: Publish on a draft, Unpublish on a published entry, and "Updating..." while the change is in flight. If the change fails, the banner shows "Failed to update publish status".

A published entry stays editable: save a change and the public changelog shows it at once; only the slug is locked.

The email digest is a single email to the project's subscribers announcing the entry. Chapter 08 covers subscribers and the digest. It goes out on a real draft-to-published transition, and at most once per entry, ever. So unpublishing and republishing sends nothing, and neither does pressing Publish on an entry that is already published. The one exception: if no email actually went out, nothing is recorded, and a later publish can still send that first digest.

Delete

Delete asks first: "Delete this entry? This cannot be undone." Cancel the dialog and nothing happens. Confirm, and the editor sends you back to the project.

What cannot be undone

  • Deleting an entry.
  • The slug, once the entry is published.
  • The first digest, once subscribers have been emailed.