Merge branch 'main' into feat/helper-tests

Author: millotp

config/release.config.json

@@ -21,5 +21,73 @@
   "gitAuthor": {
     "name": "algolia-bot",
     "email": "[email protected]"
+  },
+  "lts": {
+    "csharp": {
+      "6.1.17": {
+        "start": "2024-01-01",
+        "end": "2024-08-01"
+      }
+    },
+    "dart": {
+      "1.11.1": {
+        "start": "2024-06-12",
+        "end": "2024-12-12"
+      }
+    },
+    "go": {
+      "3.31.1": {
+        "start": "2024-01-01",
+        "end": "2024-08-01"
+      }
+    },
+    "java": {
+      "3.16.9": {
+        "start": "2024-01-01",
+        "end": "2024-08-01"
+      }
+    },
+    "javascript": {
+      "4.23.3": {
+        "start": "2024-01-01",
+        "end": "2024-08-01"
+      }
+    },
+    "kotlin": {
+      "2.1.12": {
+        "start": "2024-01-01",
+        "end": "2024-08-01"
+      }
+    },
+    "php": {
+      "3.4.1": {
+        "start": "2024-01-01",
+        "end": "2024-08-01"
+      }
+    },
+    "python": {
+      "3.0.0": {
+        "start": "2024-01-01",
+        "end": "2024-08-01"
+      }
+    },
+    "ruby": {
+      "2.3.4": {
+        "start": "2024-01-01",
+        "end": "2024-08-01"
+      }
+    },
+    "scala": {
+      "1.45.2": {
+        "start": "2024-01-01",
+        "end": "2024-08-01"
+      }
+    },
+    "swift": {
+      "8.20.1": {
+        "start": "2024-01-01",
+        "end": "2024-08-01"
+      }
+    }
   }
 }

scripts/ci/actions/restore-artifacts/builddir/index.js

@@ -17,6 +17,8 @@ import { getGitAuthor } from './release/common.js';
 import { createSpinner } from './spinners.js';
 import type { Generator, GeneratorMode, Language, RunOptions } from './types.js';
 
+export const fullReleaseConfig = releaseConfig;
+
 export const MAIN_BRANCH = releaseConfig.mainBranch;
 export const OWNER = releaseConfig.owner;
 export const REPO = releaseConfig.repo;

scripts/ci/actions/restore-artifacts/builddir/index.js.map

@@ -47,6 +47,7 @@
     "fs-extra": "11.2.0",
     "js-yaml": "4.1.0",
     "knip": "5.18.2",
+    "lts": "1.2.0",
     "micromatch": "4.0.7",
     "semver": "7.6.2",
     "spinnies": "0.5.1",

scripts/common.ts

@@ -1,6 +1,9 @@
 /* eslint-disable no-console */
+import fsp from 'fs/promises';
+
 import chalk from 'chalk';
 import dotenv from 'dotenv';
+import lts from 'lts';
 import semver from 'semver';
 
 import generationCommitText from '../ci/codegen/text.js';
@@ -19,6 +22,8 @@ import {
   gitBranchExists,
   setVerbose,
   configureGitHubAuthor,
+  fullReleaseConfig,
+  toAbsolutePath,
 } from '../common.js';
 import { getLanguageFolder, getPackageVersionDefault } from '../config.js';
 import type { Language } from '../types.js';
@@ -388,6 +393,78 @@ async function prepareGitEnvironment(): Promise<void> {
   await run('git pull origin $(git branch --show-current)');
 }
 
+// updates the release.config.json file for the lts field, which contains a release history of start and end date support
+// inspired by node: https://github.com/nodejs/Release/blob/main/schedule.json, following https://github.com/nodejs/release#release-schedule, leveraging https://github.com/nodejs/lts-schedule
+async function updateLTS(versions: Versions, withGraphs?: boolean): Promise<void> {
+  const start = new Date();
+  const end = new Date(new Date().setMonth(new Date().getMonth() + 12));
+
+  let queryStart = start;
+  let queryEnd = end;
+
+  for (const [lang, supportedVersions] of Object.entries(fullReleaseConfig.lts)) {
+    const next = versions[lang].next;
+    const current = versions[lang].current;
+
+    // no ongoing release for this client, nothing changes
+    if (!next || next === current) {
+      continue;
+    }
+
+    if (current in supportedVersions) {
+      if (versions[lang].releaseType !== 'major') {
+        // In the same major, the current version enters in maintenance mode, and the next become the new active
+        delete supportedVersions[current].active;
+      }
+
+      supportedVersions[current].maintenance = end.toISOString().split('T')[0];
+    }
+
+    supportedVersions[next] = {
+      start: start.toISOString().split('T')[0],
+      active: start.toISOString().split('T')[0],
+      end: end.toISOString().split('T')[0],
+    };
+
+    for (const [supportedVersion, dates] of Object.entries(supportedVersions)) {
+      // The support has expired, we can drop it
+      if ('maintenance' in dates && new Date(dates.maintenance as string) < start) {
+        delete supportedVersions[supportedVersion];
+
+        continue;
+      }
+
+      // Used to define the start of the rendered graph timeline
+      const versionStart = new Date(dates.start);
+      if (versionStart < queryStart) {
+        queryStart = versionStart;
+      }
+
+      // Used to define the end of the rendered graph timeline
+      const versionEnd = new Date(dates.end);
+      if (versionEnd > queryEnd) {
+        queryEnd = versionEnd;
+      }
+    }
+
+    if (withGraphs) {
+      lts.create({
+        queryStart,
+        queryEnd,
+        png: toAbsolutePath(`config/${lang}-lts.png`),
+        data: supportedVersions,
+        projectName: '',
+        excludeMaster: true,
+      });
+    }
+  }
+
+  await fsp.writeFile(
+    toAbsolutePath('config/release.config.json'),
+    JSON.stringify(fullReleaseConfig, null, 2),
+  );
+}
+
 async function createReleasePR(): Promise<void> {
   await prepareGitEnvironment();
 
@@ -398,6 +475,8 @@ async function createReleasePR(): Promise<void> {
     versions: readVersions(),
     commits: validCommits,
   });
+
+  await updateLTS(versions, true);
   const versionChanges = getVersionChangesText(versions);
 
   console.log('Creating changelogs for all languages...');