Repository navigation
docs: install from 0.1.0, and title release notes with the version - #21
Merged
Merged
Conversation
- release.yml: the 0.1.0 release notes were the whole `git cliff --unreleased` output, starting with the changelog's header and an "Unreleased" heading. They now hold only the new version's section, titled with the version (`--tag <version> --strip all`). - README: install with `.upToNextMinor(from: "0.1.0")`, since a 0.x minor version can break the API or the record format; a CI badge and a License section. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Follow-ups to the first release (
0.1.0), and review item 28.Release notes
The
0.1.0release notes were the wholegit cliff --unreleasedoutput, so they started with the changelog's# Changelogheader and an## [Unreleased]heading. tuist/sdk's workflow, whichrelease.ymlis based on, does the same.CHANGELOG.mditself was correct.The notes step now runs
git cliff --unreleased --tag "<next version>" --strip all, so a release's notes hold only its own section, titled with the version. Previewed locally on this branch:README
.upToNextMinor(from: "0.1.0")replacesbranch: "main", with a sentence on why. While the package is at 0.x, a minor version can break the API or the record format, andfrom:/.upToNextMajorwould accept 0.2.0. This also lets versioned packages depend on it, which a branch dependency doesn't allow.LICENSE(MIT).Merging this cuts
0.1.1, the first release made with the fixed notes step.🤖 Generated with Claude Code