Releasing
Releasing new versions of Outkit is a very streamlined process thanks to the Changeset release github action.
Whenever there a new changes ready to be released on the master branch, a Pull Request with the title
Version Packages will automatically be opened.
When you want to do a release, all you have to do is merge the Version Packages Pull Request and the following things
will happen:
- The version number of outkit will get bumped to a number depending on the type of changes that are getting released.
If there have only been patch changes, the new version number will only get bumped by
0.0.1. If there are patch changes and a major change, the next version will go up by a whole number. - The CHANGELOG.md file will get updated with all of the Changesets. This is why it's important to write clear and concise changesets.
- The new version of Outkit will be bundled and published to the Github Package Registry as well as tagged in git.
As soon as the next change is merged into master, the Version Packages PR will be opened again and you can repeat the
steps above.
Fore more information about Changesets, please see here
Bundling
Outkit uses Microbundle to bundle its source files to production ready files. We use Microbundle because it is zero-config, powered by Rollup, well documented and there is a large community using it.
Bundling happens automatically before releasing, so you should never really have to do this manually. But if you do want
to create a bundle, run the following command. This will create a bundle inside the dist folder.
yarn build