docs: remove SLA stuff (#3308)

Author: shortcuts

.yarn/patches/lts-npm-1.2.0-e55f0a54f7.patch

@@ -44,13 +44,9 @@ async function pushToAlgoliaDoc(): Promise<void> {
   await run(`git checkout -B ${targetBranch}`, { cwd: tempGitDir });
 
   const pathToSpecs = toAbsolutePath(`${tempGitDir}/app_data/api/specs`);
-  const pathToImages = toAbsolutePath(`${tempGitDir}/assets/images/api`);
   await run(`cp ${toAbsolutePath('specs/bundled/*.doc.yml')} ${pathToSpecs}`);
   await run(`cp ${toAbsolutePath('config/release.config.json')} ${pathToSpecs}`);
   await run(`cp ${toAbsolutePath('website/src/generated/*.json')} ${pathToSpecs}`);
-  await run(
-    `mkdir -p ${pathToImages} && cp ${toAbsolutePath('website/static/img/*-sla.png')} ${pathToImages}`,
-  );
 
   if ((await getNbGitDiff({ head: null, cwd: tempGitDir })) === 0) {
     console.log(`❎ Skipping push docs because there is no change.`);
@@ -77,7 +73,7 @@ async function pushToAlgoliaDoc(): Promise<void> {
     title: message,
     body: [
       'This PR is automatically created by https://github.com/algolia/api-clients-automation',
-      'It contains the latest released OpenAPI specs, the release SLA dates and PNGs, and the generated code snippets.',
+      'It contains the latest released OpenAPI specs, the release version support dates, and the generated code snippets.',
     ].join('\n\n'),
     base: 'master',
     head: targetBranch,

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

@@ -9,8 +9,7 @@ import { startTestServer } from '../cts/testServer';
 import { formatter } from '../formatter.js';
 import { generate } from '../generate.js';
 import { playground } from '../playground.js';
-import { createReleasePR, updateSLA } from '../release/createReleasePR.js';
-import type { Versions } from '../release/types.js';
+import { createReleasePR } from '../release/createReleasePR.js';
 import { snippetsGenerateMany } from '../snippets/generate.js';
 import { buildSpecs } from '../specs';
 import type { Language } from '../types.js';
@@ -214,16 +213,9 @@ program
     undefined,
   )
   .option('-d, --dry-run', 'does not push anything to GitHub')
-  .option('-gg, --generate-graph', 'only generates the graph')
-  .action(async (langArgs: LangArg[], { verbose, releaseType, dryRun, generateGraph }) => {
+  .action(async (langArgs: LangArg[], { verbose, releaseType, dryRun }) => {
     setVerbose(Boolean(verbose));
 
-    if (generateGraph) {
-      await updateSLA({} as Versions, true);
-
-      return;
-    }
-
     if (langArgs.length === 0) {
       langArgs = [ALL];
     }

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

@@ -45,7 +45,6 @@
     "fs-extra": "11.2.0",
     "js-yaml": "4.1.0",
     "knip": "5.23.2",
-    "lts": "patch:lts@npm%3A1.2.0#~/.yarn/patches/lts-npm-1.2.0-e55f0a54f7.patch",
     "micromatch": "4.0.7",
     "semver": "7.6.2",
     "spinnies": "0.5.1",

scripts/ci/codegen/pushToAlgoliaDoc.ts

@@ -3,7 +3,6 @@ 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';
@@ -402,60 +401,57 @@ async function prepareGitEnvironment(): Promise<void> {
 
 // updates the release.config.json file for the sla 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
-export async function updateSLA(versions: Versions, graphOnly?: boolean): Promise<void> {
+export async function updateSLA(versions: Versions): Promise<void> {
   const start = new Date();
   const end = new Date(new Date().setMonth(new Date().getMonth() + 24));
 
   let queryStart = start;
   let queryEnd = end;
 
   for (const [lang, supportedVersions] of Object.entries(fullReleaseConfig.sla)) {
-    if (!graphOnly) {
-      const next = versions[lang].next;
-      const current = versions[lang].current;
+    const next = versions[lang].next;
+    const current = versions[lang].current;
 
-      // no ongoing release for this client, nothing changes
-      if (!next || current === next) {
-        continue;
-      }
+    // no ongoing release for this client, nothing changes
+    if (!next || current === next) {
+      continue;
+    }
+
+    // update the previously supported SLA version fields
+    if (current in supportedVersions) {
+      const nextMinor = next.match(/.+\.(.+)\..*/);
+      const currentMinor = current.match(/.+\.(.+)\..*/);
 
-      // update the previously supported SLA version fields
-      if (current in supportedVersions) {
-        const nextMinor = next.match(/.+\.(.+)\..*/);
-        const currentMinor = current.match(/.+\.(.+)\..*/);
-
-        if (!currentMinor || !nextMinor) {
-          throw new Error(`unable to determine minor versions: ${currentMinor}, ${nextMinor}`);
-        }
-
-        // if it's not a major release, and we are on the same minor, we remove the current
-        // patch because we support SLA at minor level
-        if (versions[lang].releaseType !== 'major' && currentMinor[1] === nextMinor[1]) {
-          delete supportedVersions[current];
-          // if it's a major or not the same minor, it means we release a new latest versions, so the
-          // current SLA goes in maintenance mode
-        } else {
-          delete supportedVersions[current].lts;
-
-          // any other release cases make the previous version enter in maintenance
-          supportedVersions[current].maintenance = start.toISOString().split('T')[0];
-        }
+      if (!currentMinor || !nextMinor) {
+        throw new Error(`unable to determine minor versions: ${currentMinor}, ${nextMinor}`);
       }
 
-      // we don't support SLA for pre-releases, so we will:
-      // - set them as `prerelease`
-      // - not the set `lts` field, the gen script will set the as `unstable`
-      const isPreRelease =
-        next.match(preReleaseRegExp) !== null || semver.prerelease(next) !== null;
-
-      supportedVersions[next] = {
-        start: start.toISOString().split('T')[0],
-        lts: isPreRelease ? undefined : start.toISOString().split('T')[0],
-        end: end.toISOString().split('T')[0],
-        prerelease: isPreRelease,
-      };
+      // if it's not a major release, and we are on the same minor, we remove the current
+      // patch because we support SLA at minor level
+      if (versions[lang].releaseType !== 'major' && currentMinor[1] === nextMinor[1]) {
+        delete supportedVersions[current];
+        // if it's a major or not the same minor, it means we release a new latest versions, so the
+        // current SLA goes in maintenance mode
+      } else {
+        delete supportedVersions[current].lts;
+
+        // any other release cases make the previous version enter in maintenance
+        supportedVersions[current].maintenance = start.toISOString().split('T')[0];
+      }
     }
 
+    // we don't support SLA for pre-releases, so we will:
+    // - set them as `prerelease`
+    // - not the set `lts` field, the gen script will set the as `unstable`
+    const isPreRelease = next.match(preReleaseRegExp) !== null || semver.prerelease(next) !== null;
+
+    supportedVersions[next] = {
+      start: start.toISOString().split('T')[0],
+      lts: isPreRelease ? undefined : start.toISOString().split('T')[0],
+      end: end.toISOString().split('T')[0],
+      prerelease: isPreRelease,
+    };
+
     // define the boundaries of the graph by searching for older and newest dates
     for (const [supportedVersion, dates] of Object.entries(supportedVersions)) {
       // delete maintenance versions that are not supported anymore
@@ -475,14 +471,6 @@ export async function updateSLA(versions: Versions, graphOnly?: boolean): Promis
         queryEnd = versionEnd;
       }
     }
-
-    lts.create({
-      queryStart,
-      queryEnd,
-      png: toAbsolutePath(`website/static/img/${lang}-sla.png`),
-      data: supportedVersions,
-      projectName: '',
-    });
   }
 
   await fsp.writeFile(
@@ -514,7 +502,7 @@ export async function createReleasePR({
     releaseType,
   });
 
-  await updateSLA(versions, false);
+  await updateSLA(versions);
 
   const versionChanges = getVersionChangesText(versions);
 

scripts/cli/index.ts

@@ -3,8 +3,6 @@
 The CI runs on Github Actions and tries to be as efficient as possible by only running the required steps based on the changes.
 To achieve this, it's using a combination of caches and artifacts, with [matrix jobs](https://docs.github.com/en/actions/using-jobs/using-a-matrix-for-your-jobs) to run only certain languages.
 
-![CI Overview](/img/full-ci.png)
-
 ## Note on JavaScript
 
 JavaScript CI is highly specialized and contains many differences with the other clients, so it has it's own dedicated steps.

scripts/package.json

@@ -40,21 +40,3 @@ You need approval from a member of the [`@algolia/api-clients-automation`](https
 After a full CI run, a release commit will be sent to every repository and spread changes to their `next` branch.
 
 Each language repository should have their own release process, and should run only when the latest commit starts with `chore: release`. By doing so, we have a way to just update the repository, for example READMEs, without having to release.
-
-## SLA graph
-
-In order to generate the SLA graphs ([available here](/docs/clients/service-level-agreement)), we leverage the open-source Node.js tools:
-- [JSON input format file](https://github.com/nodejs/Release/blob/main/schedule.json)
-- [script](https://github.com/nodejs/lts-schedule)
-
-The source of truth data lives in [the release config file](https://github.com/algolia/api-clients-automation/blob/main/config/release.config.json), under the `lts` field.
-
-### Patch `lts` package
-
-The [`lts`](https://github.com/nodejs/lts-schedule) package has been patched (with `yarn patch lts`, see diff in `.yarn/patches`), if you edit the patch, make sure to run `yarn patch-commit -s /path/to/your/patch/folder` in order to update the lock.
-
-### Generate
-
-```bash
-apic release -gg
-```