From ea3fafbe2ea4ddaef2f32f43c18b0f245f16f4f9 Mon Sep 17 00:00:00 2001 From: Rob Decker <852280+robdecker@users.noreply.github.com> Date: Fri, 8 May 2026 16:05:41 -0700 Subject: [PATCH] docs: document branch model and update supported versions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add "Branch model" section to MAINTAINING.md explaining the roles of main / v2.0 / v1.6 and their Vercel docs subdomain mapping. Includes guidance on where to target a PR based on change type. - Replace stale "Docs" deployment list (v1.6/v1/v0) with the current branch → subdomain mapping. Drop the @TODO marker now that the details are filled in. - Update SECURITY.md supported-versions tables for both `next-drupal` and the `next` Drupal module to include 2.x.x. --- MAINTAINING.md | 29 ++++++++++++++++++++++++----- SECURITY.md | 2 ++ 2 files changed, 26 insertions(+), 5 deletions(-) diff --git a/MAINTAINING.md b/MAINTAINING.md index 26344f687..e9dfa11fb 100644 --- a/MAINTAINING.md +++ b/MAINTAINING.md @@ -2,6 +2,25 @@ This document is for maintainers to explain the various procedures for all the projects in this monorepo. +## Branch model + +This monorepo uses three active branches that serve different roles in the release lifecycle. Each is also wired to a separate Vercel docs deployment. + +| Branch | Role | Vercel deployment | +| ------ | ---- | ----------------- | +| `main` | Active development for the next major release. New features land here first. | https://next.next-drupal.org/ | +| `v2.0` | Pre-release staging. Features merge here from `main` once they are release-candidate quality, then are published to npm. | https://next-drupal.org/ | +| `v1.6` | Older supported version (security and critical fixes only). | https://v1-6.next-drupal.org/ | + +Older release branches (`v1`, `v0`) exist for historical reference but are no longer Vercel-deployed and do not receive patches. See `SECURITY.md` for the supported-versions matrix. + +### Where to target a PR + +- **New feature for the next major release** — open against `main`. +- **Backport / patch for the current stable line** — open against `v2.0`. +- **Security or critical fix for the older supported line** — open against `v1.6`. +- **Docs-only change for a specific version's docs site** — open against the branch whose Vercel deployment you want to update. For general-purpose docs, target `main` and let the release flow propagate. + ## Making releases ### `next` (Drupal Module) @@ -181,13 +200,13 @@ The code in the examples repos do not strictly require a versioned release since ### Docs -@TODO: Expand details the next time docs are deployed. - Documentation is deployed to Vercel and controlled via the following Git branches: -- `v1.6` -- `v1` -- `v0` +- `main` → https://next.next-drupal.org/ +- `v2.0` → https://next-drupal.org/ +- `v1.6` → https://v1-6.next-drupal.org/ + +Each branch's Vercel project auto-deploys on push. ## Tests diff --git a/SECURITY.md b/SECURITY.md index d586d073b..9531412fa 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -8,6 +8,7 @@ Refer to the table below for versions supported with security updates. | Version | Supported | | ------- | ------------------ | +| 2.x.x | :white_check_mark: | | 1.x.x | :white_check_mark: | | < 1.0.0 | :x: | @@ -15,6 +16,7 @@ Refer to the table below for versions supported with security updates. | Version | Supported | | ------- | ------------------ | +| 2.x.x | :white_check_mark: | | 1.x.x | :white_check_mark: | | < 1.0.0 | :x: |