Repository navigation
Add a changelog, an upgrade guide, a release workflow and version 1.0.1 - #2
Merged
Merged
Conversation
Lists the 1.0.0 breaking changes and adds an Upgrading from 0.x section to the README. Names the type file for every export condition, ships CHANGELOG.md, and updates the author and copyright years.
npm run release now only tags and pushes. The Release workflow checks the tag against package.json, runs the tests and size limits, publishes with npm trusted publishing and creates the release from the CHANGELOG.md section.
devmaxxx
changed the title
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
1 participant
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
CHANGELOG.mdwith the 1.0.0 breaking changes, additions and fixes, and ship it in the package.purifyallows tags and attributes,componentsentries are now rendered as React components.typesconditions per entry inexports,publishConfig.access,authorwith name and URL, copyright years inLICENSE.md..github/workflows/release.yml): a version tag publishes to npm through trusted publishing and creates the GitHub release from the matchingCHANGELOG.mdsection.npm run releasenow only tags and pushes.Test plan
npm test: 208/208npm run build+publint: all goodattw --pack: green for node10, node16 (CJS and ESM) and bundler on every entrysize-limitwithin limitsrelease.ymlnpm run releaseonmainpublishes 1.0.1