Skip to content

docs: document branch model and update supported versions #904

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
robdecker wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document branch model and update supported versions #904

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 24 additions & 5 deletions MAINTAINING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,15 @@ 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: |

### `next` Drupal module

| Version | Supported |
| ------- | ------------------ |
| 2.x.x | :white_check_mark: |
| 1.x.x | :white_check_mark: |
| < 1.0.0 | :x: |

Expand Down
Loading