docs: add changelog generation via git-cliff#20
Merged
Merged
Conversation
Add CHANGELOG.md with a 0.1.0 entry covering the package scaffold, the deterministic Pandoc conversion core, the three transports (local file, SharePoint, Google Drive), and docx-to-markdown reverse conversion. Entries are generated with git-cliff from cliff.toml, exposed as `changelog` (full regeneration), `changelog:preview` (show unreleased without writing), and `changelog:release` (prepend unreleased, leaving published entries intact) package scripts. cliff.toml filters merge commits out of the changelog, and includes a commit preprocessor that normalizes the squash-merge subject of PR #16 back to a conventional `feat:` prefix -- GitHub uses the PR title as the squash commit subject, and #16's title lacked the prefix, so without this preprocessor that work is silently dropped from generated output. Dependency and API-shape notes that no commit subject can convey -- `fflate` now being a runtime dependency, `google-auth-library` as an optional peer, and `PandocErrorCode`/`TransportErrorCode` being open unions -- are hand-added to the 0.1.0 release entry. That's why `changelog:release` (prepend) is preferred over a full regeneration once a version has shipped: regenerating from history would discard those hand-written notes. Closes #19
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Changes
Documentation
fflatenow a runtime dependency,google-auth-libraryan optional peer,PandocErrorCode/TransportErrorCodebeing open unions) are hand-added to the release entry.Build System
changelog(full regeneration),changelog:preview(show unreleased without writing), andchangelog:release(prepend unreleased, leaving published entries intact) scripts.changelog:releaseis preferred over a full regeneration once a version ships, since regenerating from history would discard the hand-added dependency/API notes above.Test plan
pnpm changelog:previewruns cleanlypnpm changelog:releaseprepends correctly without touching the 0.1.0 entryCloses #19