Add Release Strategy Document

.spellcheck-en-custom.txt

@@ -1,16 +1,22 @@
 # make spellcheck-sort
 # Please keep this file sorted:
 # SPDX-License-Identifier: Apache-2.0
+Backport
+backported
+codebase
 Dataset
 dataset
 datasets
+distractor
 FIXME
 freeform
 ICL
 icl
 JSON
 Langchain's
+LLM
 LLMBlock
+MCQ
 MMLU
 Ouput
 Pre
@@ -26,6 +32,3 @@ unchunked
 UUID
 vLLM
 yaml
-LLM
-MCQ
-distractor

docs/release-strategy.md

@@ -0,0 +1,64 @@
+# InstructLab SDG Release Strategy
+
+This document discusses the release strategy and processes for the
+`instructlab-sdg` Python package built from the
+<https://github.com/instructlab/sdg> git repository.
+
+## Versioning Scheme
+
+Releases use a `X.Y.Z` numbering scheme.
+
+X-stream release are for major releases. At this stage in the project a major release has not been cut and we expect each release to be a new Y-stream.
+
+Z-stream releases are meant for critical bug and documentation fixes. Z-stream releases are cut as maintainers see fit.
+
+## Schedule
+
+The project currently operates on an ad-hoc release schedule based on the discretion of the maintainers team.
+
+The cadence for major releases starting from 1.0 onward will be determined as the project matures.
+
+A schedule will be updated in a markdown file on the <https://github.com/instructlab/sdg> GitHub repository.
+
+## Release Tracking
+
+Currently there is no formal process of release tracking. GitHub Issues are used for tracking individual work items.
+
+In the future, the project may use Milestones or Project Boards for more formal release planning. At that time this document will be updated.
+
+## Git Branches and Tags
+
+Every `X.Y` release stream gets a new branch.
+
+Each release, `X.Y.Z`, exists as a tag named `vX.Y.Z`.
+
+## Release Branch Maintenance
+
+Maintenance efforts are only on the most recent Y-stream.
+Critical bug fixes are backported to the most recent release branch.
+
+## Release Mechanics
+
+Release mechanics are done by a Release Manager identified for that release.
+The Release Manager is a member of the SDG Maintainers team that has agreed to take on these responsibilities.
+The Release Manager can change on a per-release basis.
+
+The following are the steps for how Y-stream and Z-stream releases gets cut.
+
+### Y-Stream
+
+1. Determine a commit on the main branch that will serve as the basis for the next release - most of the time this should be the latest commit.
+1. Create a new release branch in the format `release-vX.Y` off of the determined commit (will match `main` if the latest commit is chosen).
+1. Create a new release on GitHub targeting the release branch and using the latest Y-Stream tag as the previous release (e.g. `0.15.1` precedes `0.16.0`).
+1. Announce release via the following:
+    - The `#sdg` channel on Slack
+    - The `dev` mailing list
+
+### Z-Stream
+
+1. Backport all relevant commits from `main` to the `release-vX.Y` branch.
+    - It may also be the case you wish to update release branch first - if this approach is taken, ensure any relevant commits are subsequently backported to `main`
+1. Create a new release on GitHub targeting the release branch and using the previous Z-Stream tag as the previous release (e.g. `0.15.0` precedes `0.15.1`).
+1. If changes warrant an announcement, announce via the following:
+    - The `#sdg` channel on Slack
+    - The `dev` mailing list