Write a changelog entry in a fixed format from commit history

A changelog entry in the sample's format with full commit hashes.

Choose one of three approaches. The steps for that option appear below.

Choose an option above. On a phone, swipe the tabs left or right to see all options →

Claude: classifies commits, formats entry, you check

Claude classifies every commit, then formats the entry. You correct the table and approve the result.

  1. You

    Gather log, sample

  2. Claude

    Classify commits

  3. You

    Correct table

  4. Claude

    Format entry

  5. You

    Check and decide

  1. Gather the commit log and format sample

    Use: You

    Have ready: the commit log between the two tags and the changelog format sample.

    Check

    Check the log covers the tag range and the sample is the one to follow.

  2. Classify every commit

    Use: Claude

    Ask Claude to classify every commit between the two tags.

    Details

    What to paste into the tool

    The log I paste is a copy: codes such as D1 stand in for committer names and emails. Here is the commit log between two tags. Classify every commit as added, changed, fixed, removed or breaking, one row per commit with its hash. Mark anything user-visible. If a commit could be breaking, mark it breaking rather than guessing safe. List any commit you are unsure how to classify as 'needs maintainer decision' instead of dropping it. Keep the codes exactly as written.

  3. Correct the classification table

    Use: You

    Check every user-visible commit appears with its hash and breaking changes are marked. Fix miscategorised rows.

    Check

    Check every commit marked breaking against the diff, and look for breaking changes that are not marked.

  4. Format the entry to the sample

    Use: Claude

    Ask Claude to format the entry to the sample format, keeping every hash.

    Details

    What to paste into the tool

    The log I paste is a copy: codes such as D1 stand in for committer names and emails. Format this approved classification table as a changelog entry that matches the supplied sample's format - same headings, ordering, hash style and punctuation. Do not add sections, do not paraphrase commit summaries beyond what the format allows, and keep every hash. Keep the codes exactly as written.

  5. Check the entry, then approve or hold

    Use: You

    Check the entry against the approved table and the sample format, then approve or hold it. The entry keeps hashes and summaries only.

    Check

    Check headings, ordering, hash style and punctuation match the sample; every hash kept, nothing added. Approve only when it matches; otherwise hold it and list the fixes.

Before you paste into any AI tool, remove any confidential information. Put it back at the end.

Tools in this workflow

Deciding between ChatGPT and Claude for this? See the comparison.

Final check

Every user-visible commit appears with a hash and breaking changes are marked.

Maintainer confirms the entry before it is used.

The project's format is kept to the supplied sample (source constraint).

Nothing is tagged or published.

Check the result against your original inputs. Approve it before sharing or acting.

What still needs checking
  • Exact paste limits for long commit logs are not published on the cited pages.

Share this page