chore(scripts): add version history script

Author: shortcuts

config/release.config.json

@@ -1,5 +1,5 @@
 module.exports = {
-  ignorePatterns: ['**.yml', 'tsconfig.json'],
+  ignorePatterns: ['**.yml', 'tsconfig.json', 'foo'],
 
   extends: "../.eslintrc.cjs",
 

scripts/.eslintrc.cjs

@@ -1,7 +1,7 @@
 /* eslint-disable no-console */
 
 import { ensureGitHubToken, getOctokit, OWNER, run, setVerbose, toAbsolutePath } from '../../common';
-import { isPreRelease } from '../../release/sla';
+import { isPreRelease } from '../../release/versionsHistory';
 import type { Language } from '../../types';
 import { cloneRepository } from '../utils';
 

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

@@ -86,15 +86,6 @@ async function pushToAlgoliaDoc(): Promise<void> {
     head: targetBranch,
   });
 
-  await octokit.issues.createComment({
-    owner: OWNER,
-    repo: repository,
-    issue_number: data.number,
-    body: [
-      `[**Preview SLA changes&rarr;**](https://deploy-preview-${data.number}--algolia-docs.netlify.app/doc/libraries/supported-versions/)`,
-    ].join('\n\n'),
-  });
-
   console.log(`Pull request created on ${OWNER}/${repository}`);
   console.log(`  > ${data.url}`);
 }

scripts/ci/codegen/createGitHubReleases.ts

@@ -11,7 +11,7 @@ import { formatter } from '../formatter.js';
 import { generate } from '../generate.js';
 import { playground } from '../playground.js';
 import { createReleasePR } from '../release/createReleasePR.js';
-import { generateSLA } from '../release/sla.js';
+import { generateVersionsHistory } from '../release/versionsHistory.js';
 import { snippetsGenerateMany } from '../snippets/generate.js';
 import { buildSpecs } from '../specs';
 import type { Language } from '../types.js';
@@ -255,13 +255,13 @@ program
     undefined,
   )
   .option('-d, --dry-run', 'does not push anything to GitHub')
-  .option('-sla, --sla-only', 'only generates the sla policy', false)
+  .option('-vh, --versions-history', 'only generates the versions-history policy', false)
   .option('-b --breaking', 'allow breaking change on the CI', false)
-  .action(async ({ verbose, releaseType, dryRun, slaOnly, breaking }) => {
+  .action(async ({ verbose, releaseType, dryRun, versionsHistory, breaking }) => {
     setVerbose(Boolean(verbose));
 
-    if (slaOnly) {
-      await generateSLA({});
+    if (versionsHistory) {
+      await generateVersionsHistory({});
 
       return;
     }

scripts/ci/codegen/pushToAlgoliaDoc.ts

@@ -1,22 +1,22 @@
-// @ts-nocheck this file is broken while the SLA is unclear
+// @ts-nocheck this file is broken while the VersionsHistory is unclear
 import { describe, expect, it } from 'vitest';
 
 import { fullReleaseConfig, LANGUAGES } from '../../common.js';
-import { generateLanguageSLA } from '../sla.js';
+import { generateLanguageVersionsHistory } from '../versionsHistory.js';
 
-describe('generateLanguageSLA', () => {
+describe('generateLanguageVersionsHistory', () => {
   LANGUAGES.forEach((lang) => {
-    if (!('sla' in fullReleaseConfig)) {
-      fullReleaseConfig.sla = {};
+    if (!('versionsHistory' in fullReleaseConfig)) {
+      fullReleaseConfig.versionsHistory = {};
     }
 
     // @ts-expect-error
-    fullReleaseConfig.sla[lang] = {};
+    fullReleaseConfig.versionsHistory[lang] = {};
   });
 
   describe('no new releases', () => {
     it('parses version of the same minor', () => {
-      generateLanguageSLA(
+      generateLanguageVersionsHistory(
         [
           '1.2.4 Thu Dec 28 15:48:25 2023 +0000',
           '1.2.5 Tue Jan 2 14:17:11 2024 +0000',
@@ -28,7 +28,7 @@ describe('generateLanguageSLA', () => {
       );
 
       // @ts-expect-error
-      expect(fullReleaseConfig.sla.csharp).toEqual({
+      expect(fullReleaseConfig.versionsHistory.csharp).toEqual({
         '1.2.4': {
           releaseDate: '2023-12-28',
           supportEnd: '2024-01-02',
@@ -52,7 +52,7 @@ describe('generateLanguageSLA', () => {
     });
 
     it('parses version of different same minor', () => {
-      generateLanguageSLA(
+      generateLanguageVersionsHistory(
         [
           '1.1.4 Thu Dec 28 15:48:25 2023 +0000',
           '1.2.5 Tue Jan 2 14:17:11 2024 +0000',
@@ -64,7 +64,7 @@ describe('generateLanguageSLA', () => {
       );
 
       // @ts-expect-error
-      expect(fullReleaseConfig.sla.javascript).toEqual({
+      expect(fullReleaseConfig.versionsHistory.javascript).toEqual({
         '1.1.4': {
           releaseDate: '2023-12-28',
           supportEnd: '2026-01-02',
@@ -91,7 +91,7 @@ describe('generateLanguageSLA', () => {
     });
 
     it('ignores versions older than 2 years', () => {
-      generateLanguageSLA(
+      generateLanguageVersionsHistory(
         [
           'v1.0.9 Thu Dec 28 15:48:25 2011 +0000',
           'v1.1.4 Thu Dec 28 15:48:25 2021 +0000',
@@ -102,7 +102,7 @@ describe('generateLanguageSLA', () => {
       );
 
       // @ts-expect-error
-      expect(fullReleaseConfig.sla.php).toEqual({
+      expect(fullReleaseConfig.versionsHistory.php).toEqual({
         '1.1.4': {
           releaseDate: '2021-12-28',
           supportEnd: '2026-01-02',
@@ -118,16 +118,20 @@ describe('generateLanguageSLA', () => {
 
     it('overrides the previously stored versions and sanitize v prefixed versions', () => {
       // @ts-expect-error
-      fullReleaseConfig.sla.go = { '0.1.2': { releaseDate: '2014-01-04', supportStatus: 'active' } };
+      fullReleaseConfig.versionsHistory.go = { '0.1.2': { releaseDate: '2014-01-04', supportStatus: 'active' } };
 
-      generateLanguageSLA(['v1.1.4 Thu Dec 28 15:48:25 2023 +0000', 'v1.4.7 Tue Jan 2 14:17:11 2024 +0000'], 'go', {
-        current: '1.4.7',
-        next: null,
-        releaseType: null,
-      });
+      generateLanguageVersionsHistory(
+        ['v1.1.4 Thu Dec 28 15:48:25 2023 +0000', 'v1.4.7 Tue Jan 2 14:17:11 2024 +0000'],
+        'go',
+        {
+          current: '1.4.7',
+          next: null,
+          releaseType: null,
+        },
+      );
 
       // @ts-expect-error
-      expect(fullReleaseConfig.sla.go).toEqual({
+      expect(fullReleaseConfig.versionsHistory.go).toEqual({
         '1.1.4': {
           releaseDate: '2023-12-28',
           supportEnd: '2026-01-02',
@@ -148,14 +152,14 @@ describe('generateLanguageSLA', () => {
     end.setFullYear(start.getFullYear() + 2);
 
     it('same version as active version', () => {
-      generateLanguageSLA(['1.2.4 Thu Dec 28 15:48:25 2023 +0000'], 'dart', {
+      generateLanguageVersionsHistory(['1.2.4 Thu Dec 28 15:48:25 2023 +0000'], 'dart', {
         next: '1.2.4',
         current: '1.2.4',
         releaseType: 'minor',
       });
 
       // @ts-expect-error
-      expect(fullReleaseConfig.sla.dart).toEqual({
+      expect(fullReleaseConfig.versionsHistory.dart).toEqual({
         '1.2.4': {
           releaseDate: '2023-12-28',
           supportStatus: 'active',
@@ -164,14 +168,14 @@ describe('generateLanguageSLA', () => {
     });
 
     it('new major: sets the new release as active, sets the last tag as maintenance', () => {
-      generateLanguageSLA(['1.2.4 Thu Dec 28 15:48:25 2023 +0000'], 'dart', {
+      generateLanguageVersionsHistory(['1.2.4 Thu Dec 28 15:48:25 2023 +0000'], 'dart', {
         next: '2.0.0',
         current: '1.2.4',
         releaseType: 'major',
       });
 
       // @ts-expect-error
-      expect(fullReleaseConfig.sla.dart).toEqual({
+      expect(fullReleaseConfig.versionsHistory.dart).toEqual({
         '1.2.4': {
           releaseDate: '2023-12-28',
           supportEnd: end.toISOString().split('T')[0],
@@ -186,14 +190,14 @@ describe('generateLanguageSLA', () => {
     });
 
     it('new minor: sets the new release as active, sets the last tag as maintenance', () => {
-      generateLanguageSLA(['1.2.4 Thu Dec 28 15:48:25 2023 +0000'], 'kotlin', {
+      generateLanguageVersionsHistory(['1.2.4 Thu Dec 28 15:48:25 2023 +0000'], 'kotlin', {
         next: '1.3.0',
         current: '1.2.4',
         releaseType: 'minor',
       });
 
       // @ts-expect-error
-      expect(fullReleaseConfig.sla.kotlin).toEqual({
+      expect(fullReleaseConfig.versionsHistory.kotlin).toEqual({
         '1.2.4': {
           releaseDate: '2023-12-28',
           supportEnd: end.toISOString().split('T')[0],
@@ -208,14 +212,14 @@ describe('generateLanguageSLA', () => {
     });
 
     it('new patch: sets the new release as active, sets the last tag as inactive', () => {
-      generateLanguageSLA(['1.2.4 Thu Dec 28 15:48:25 2023 +0000'], 'swift', {
+      generateLanguageVersionsHistory(['1.2.4 Thu Dec 28 15:48:25 2023 +0000'], 'swift', {
         next: '1.2.5',
         current: '1.2.4',
         releaseType: 'patch',
       });
 
       // @ts-expect-error
-      expect(fullReleaseConfig.sla.swift).toEqual({
+      expect(fullReleaseConfig.versionsHistory.swift).toEqual({
         '1.2.4': {
           releaseDate: '2023-12-28',
           supportEnd: start.toISOString().split('T')[0],

scripts/cli/index.ts

@@ -26,10 +26,10 @@ import { getPackageVersionDefault } from '../config.js';
 import type { Language } from '../types.js';
 
 import { getFileChanges, getLastReleasedTag } from './common.js';
-import { generateSLA } from './sla.js';
 import TEXT from './text.js';
 import type { Versions, ParsedCommit, Commit, Changelog, Scope, CommitType } from './types.js';
 import { updateAPIVersions } from './updateAPIVersions.js';
+import { generateVersionsHistory } from './versionsHistory.js';
 
 dotenv.config({ path: path.resolve(ROOT_DIR, '.env') });
 
@@ -343,9 +343,9 @@ export async function createReleasePR({
 
   const versions = decideReleaseStrategy({ commits: validCommits, releaseType });
 
-  // skip anything sla related for now
-  if (process.env.SLA) {
-    await generateSLA(versions);
+  // skip anything versionsHistory related for now
+  if (process.env.VersionsHistory) {
+    await generateVersionsHistory(versions);
   }
 
   const versionChanges = getVersionChangesText(versions);