-
Notifications
You must be signed in to change notification settings - Fork 14
Playbook Releases: Overview
Playbook releases may occur anytime a PR (or group of PRs) is merged to master. If these updates are needed in our other applications, a release is created. A release will not be created solely for general updates such as upgrades to the website or documentation. The release team will use their best judgment based on PR volume and magnitude. The team may also skip a release during a holiday week, but will create any critical release patches as needed.
@jasoncypret @thestephenmarshall @jasperfurniss
If you want to get notified about new releases, you can subscribe to this project to get notifications when a new release tag is created. You can also subscribe on RubyGems.org or npm.
You have a couple of options available to you if you want to test a kit. You can use yarn link or change your package.json & Gemfile paths to point to a path on your local machine. Depending on your environment, the aforementioned methods may not work. The best way to test is to request an "alpha" version to be created for you based on your working branch in Github. Reach out to the release team from within your PR to set this up. For more information see this page.
Playbook will adhere as closely as possible to the Semantic Versioning Guidelines when creating new release versions.
It is important that the contributor is aware of versioning patterns. Details should be added in the working PR for the release team to determine the type of release to be made: minor, major, patch, pre (alpha)
-
major2.0.0 - *Non-backwards compatible updates to kits, major architectural changes or redesigns -
minor1.1.0 - New kits, updates to kit props, display or logic that are *backwards compatible -
patch2.0.1 - backwards compatible bug fixes -
pre (alpha)- Pre-release versions not for production - used for testing functionality
For more information about "how" to create a Playbook release, see our Huddle docs.