chore(ci): add changesets

[jeetiss]

release automation with changesets

changesets provides an automated monopackage release flow with a review.

here are steps from PR to release:

• a user creates PR
• maintainer or user adds a changeset that contains a description and information about affected packages and release type (patch, minor, major) like this
• GitHub action creates a pull request with generated changelogs and bumped versions for packages that are changed
• release engineer reviews changes and merge them
• GitHub action publishes the new versions to npm and creates a release note for all packages at github

Lerna has a similar release flow with semantic releases, but changeset is better because:

• files are more flexible for change descriptions than commit messages
• it has a review step that allows to check and change something at the last moment
• it has all steps automation out of the box

TODOs

• add changesets bot
• add automation npm token for releases

[diegomura]

@jeetiss can you explain the motivation of this? Isn't Lerna do some of this stuff already?

[jeetiss]

@diegomura sure.
I'm finalizing our migration to v2, and after i'm back with motivation explanations and the new prs.

now v2 works the same as v1, and i'm happy that i don't need to rewrite components

[jeetiss]

@diegomura could you add NPM_TOKEN to github secrets? it should be an automation token that github announced couple days ago

[jeetiss]

GITHUB_TOKEN is provided on default, so you don't need to add it.

[jeetiss]

@diegomura i add some explanation to PR description

Isn't Lerna do some of this stuff already?

yes, changesets is inspired by lerna but improves all aspects of release.

last thing. I tried to automate all possible things, so if you want to run some steps manually, just say and i prepare it here 😄

[diegomura]

@jeetiss thanks for merging this and improving the release cycle. And also for all the hard work you are putting on the project. I'll try to be more responsive and present than I've been for the last weeks.

Can you quickly explain how this changes how to publish a new version? I'm not sure I grasped 100% of wht changesets does

[jeetiss]

@diegomura hooray 🙌🏻

I am almost ready with the new release, I'm going to finish [this fix] (#1659) today, and after we can release

changesets

I can't explain it better than changesets maintainers do, so read this article

here are the changesets of all PRs that I merged

• https://github.com/diegomura/react-pdf/tree/master/.changeset

changeset's github action generates a PR with generated changelogs and bumped versions for all packages, based on these files, you can check PR here

• Version Packages #1653

I have finished the setup, but you need to add npm automation token with the name NPM_TOKEN to github secrets, for automated publishing to npm, this is the last step for release

here the screen

[diegomura]

I kept reading about it and things make much sense now. Thanks! Just added the token. Does that token allows changelogs to publish any package under my name? How is it that releases through GH will work?

[jeetiss]

thanks, it works ✨
https://github.com/diegomura/react-pdf/runs/4815869743?check_suite_focus=true#step:5:7

Does that token allows changelogs to publish any package under my name?

Yes, it can release all packages placed in this repository under your name.
It is secure, nobody can steal the token, and your secrets don't work in forks

How is it that releases through GH will work?

it should work like a magic ✨

when I merge PR

• Version Packages #1653

all changeset files will be removed and release github action run changeset publish because of that, it should release the new packages automatically ✨