Maintainers :: Cutting a Major Version

A major version bump of signal_analog is required any time a change is made to the library that is incompatible with previous versions of the library. A brief example of this would be changing the method signature for any public API in the library.

Here is a loose guide for cutting a new major version:

1. Create a major version branch from master called version/N where N is the major version we will release
   • All code for this version should be PR'ed into this branch
2. Create a major version branch from master called version/(N-1) where (N-1) is the previous version we will be supporting
   • This should contain the last released tag
3. Determine the feature set that will be released with the major version bump
   • Is this an opportunity to make a few other breaking changes that we were wary of making before?
4. Document the steps that end users will need to take in order to successfully migrate from the previous major version
   • This does not need to be fully automated
5. Craft release messages for internal/external channels
6. Update CHANGELOG.md with changes, link to the migration guide
7. Deploy and release!