From 691e55c0a4b034fd8190dbc300c1a39edcead4e9 Mon Sep 17 00:00:00 2001 From: Guy Sartorelli Date: Fri, 22 Jul 2022 12:18:31 +1200 Subject: [PATCH] DOC Add steps for updating in various scenarious --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 0d9e959..7cdfb0a 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,24 @@ Silverstripe CMS 4.x is stored in The userhelp documentation is stored in the [silverstripe/silverstripe-userhelp-content repo](https://github.com/silverstripe/silverstripe-userhelp-content/). +## What to update when creating a new pre-release major branch, making a stable major release, or making a major EOL + +When **creating a new major branch for a pre-release major version** + +- Make sure you've added a new major branch to both `silverstripe/developer-docs` and `silverstripe/silverstripe-userhelp-content` + - You probably need to add new major branches for various modules as defined in `sources-user.js` as well +- Add the new major to `sources-docs.js` and `sources-user.js` +- Add the new major to the version select in `src/components/Header.tsx` +- Add the major to the `PRE_RELEASE` array in the `getVersionMessage` function in `src/utils/nodes.ts` + +For **new stable releases**, you will need to do the following + +- Remove the major from the `PRE_RELEASE` array in the `getVersionMessage` function in `src/utils/nodes.ts` +- Update the `getDefaultVersion` function's return value to the new stable major in `src/utils/nodes.ts` +- Update redirects in `netlify.toml` + +When a **major goes EOL**, add the major to the `EOL` array in the `getVersionMessage` function in `src/utils/nodes.ts` + ## Installation To set up a local instance of [doc.silverstripe.org](https://github.com/silverstripe/doc.silverstripe.org):