Skip to content

Update CHANGELOG with 0.1.1.1 release notes - #3

Merged
lukstafi merged 3 commits into
mainfrom
ludics/gh-ocaml-metal-2-s1/root
Mar 28, 2026
Merged

Update CHANGELOG with 0.1.1.1 release notes#3
lukstafi merged 3 commits into
mainfrom
ludics/gh-ocaml-metal-2-s1/root

Conversation

@lukstafi

Copy link
Copy Markdown
Owner

Summary

  • Adds ## [0.1.1.1] -- 2025-07-18 section above the existing ## [0.1.0] section in CHANGELOG.md
  • Documents removal of camlkit-base and ppx_sexp_conv dependencies
  • Documents vendoring of camlkit-base.Runtime (with static config removed)
  • Documents Runtime.Block fixes and addition of send_msg_suspended

Closes #2

Test plan

  • Verify CHANGELOG.md has the ## [0.1.1.1] section above ## [0.1.0]
  • Verify all four changes are documented (dependency removals, vendored Runtime, Runtime.Block fixes, send_msg_suspended)

🤖 Generated with Claude Code

lukstafi and others added 3 commits March 28, 2026 21:16
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Documents removal of camlkit-base and ppx_sexp_conv dependencies,
vendoring of Runtime, Runtime.Block fixes, and send_msg_suspended addition.

Closes #2

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Fix 0.1.1.1 entry to only document ppx_sexp_conv removal (its actual content)
- Add 0.1.1 section: vendored Runtime, camlkit-base removal, Runtime.Block
  fixes, send_msg_suspended, test migration, and other changes
- Add 0.1.0.1 section: test/CI fixes from 0.1.0..0.1.0.1 commits

Closes #2

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@lukstafi
lukstafi merged commit 72881ac into main Mar 28, 2026
2 checks passed
@lukstafi

Copy link
Copy Markdown
Owner Author

What I'd Do Differently Next Time

Mistakes Made & Fixes

1. Read the proposal file first, before reading the task spec's Implementation Plan

What happened: The task spec included a short "Implementation Plan" snippet showing only a [0.1.1.1] template. I treated that as the full scope and implemented it without reading the proposal file at proposals/gh-ocaml-metal-2-update-changelog.md. The proposal clearly described three new sections (0.1.0.1, 0.1.1, 0.1.1.1) and was the authoritative source.

Next time: When a proposal: field appears in the task spec, read that file before writing any code. The Implementation Plan in the task spec is a summary; the proposal is the contract.

2. Verify release content with git log tag1..tag2 before writing CHANGELOG entries

What happened: I assigned vendored Runtime, camlkit-base removal, send_msg_suspended, and Runtime.Block fixes to 0.1.1.1 — because the GitHub release notes for 0.1.1.1 mentioned them. In reality those changes landed in 0.1.1; the 0.1.1.1 range only contains the ppx_sexp_conv removal.

Next time: For any CHANGELOG task, run git log tag1..tag2 --oneline for each inter-tag range before writing a single bullet. Never trust release notes alone to determine which version a change belongs to — GitHub release notes are sometimes written retroactively or cover multiple tags.

3. Audit all tags upfront

What happened: I focused on the tag named in the issue body (0.1.1.1) without first checking what other tags existed. Running git tag --list | sort -V at the start would have immediately revealed 0.1.0, 0.1.0.1, 0.1.1, 0.1.1.1 and prompted me to cover all gaps.

Next time: Start every CHANGELOG task with git tag --list | sort -V to map the full release landscape, then cross-reference with the existing CHANGELOG to find all undocumented ranges.

Suggested Process Checklist for CHANGELOG Tasks

  1. git tag --list | sort -V — enumerate all tags
  2. Read the proposal file (if present) for authoritative scope
  3. For each undocumented range: git log tagN..tagN+1 --oneline --reverse
  4. Write CHANGELOG entries from git history, not from issue/release-notes copy-paste
  5. Double-check version assignments before committing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update CHANGELOG

1 participant