In our last dev call, we said that we'd like to start keeping notes, during
vX.{odd} versions about what you'll need to do to upgrade to the next vX.{even}
version. This is important! We expect most people only run stable versions,
and will want to know what kind of upgrade process might exist before they
start upgrading.
Right now, this kind of documentation gets written only at the end of the
development cycle, often by someone who was not closely involved in the
development of changes. Also, we (Fastmail) tend to upgrade quite often, so
we're not building any sort of coherent single "major upgrade" document. The
goal here is to write lots of little ones, which can be unified into a larger
document as branches are merged.
But we need to decide how it works. So, here is a specific suggestion. If it
works, let's do it. If not, somebody suggest something better. I am not
personally invested in this suggestion per se!
1. We make a directory in the repo called *upgrading*.
2. In that directory, we make a directory called *next*.
3. Feature branches are expected to add a file to upgrading/next that explains
their upgrade requirements.
4. When v3.x.0 is being prepared, the release manager consolidates all the
upgrading/next/* files into upgrading/v3.x.0
The end.
Thoughts?
--
Ricardo Signes (rjbs)
------------------------------------------
Cyrus: Devel
Permalink:
https://cyrus.topicbox.com/groups/devel/Taa08486771d9b334-M3bfb91867ab0b82611c773fc
Delivery options: https://cyrus.topicbox.com/groups/devel/subscription
