How I maintain release notes for curl
a day ago
- #automation
- #documentation
- #release-notes
- Clear and thorough documentation is essential for a good product.
- Detailed and informative release notes are crucial for shipping a quality product.
- The curl project uses scripts to maintain RELEASE NOTES and documentation.
- maketgz is a foundational script for generating release tarballs, with a containerized version called dmaketgz.
- verify-release script ensures tarball contents originate from the git repository and release tools.
- release-notes.pl generates RELEASE-NOTES by parsing git log since the last 'synced' commit.
- Manual review of release notes is required to categorize changes and remove irrelevant entries.
- release-notes.pl cleanup sorts bugfixes alphabetically and removes orphaned references.
- contributors.sh extracts and formats contributor names for inclusion in RELEASE-NOTES.
- delta script provides statistics comparing the current repository state to the most recent release.
- Updated RELEASE-NOTES are committed with the message 'RELEASE-NOTES: synced' for automation tracking.
- Current in-progress release notes are available on the curl website.
- A git alias 'latest' helps list changes since the last release notes update.