Reject changesets with major bumps

.changeset/mighty-hounds-fly.md

@@ -0,0 +1,7 @@
+---
+"@siteimprove/alfa-toolchain": minor
+---
+
+**Added:** Structure validation can now optionally check that changeset contain no "major" bump.
+
+The option can be turned on for pre-1.0.0 projects, and turned off when moving to 1.0.0.

config/validate-structure.json

@@ -1,6 +1,7 @@
 {
   "has-api-extractor-config": true,
   "validate-changesets": true,
+  "forbid-major": true,
   "validate-package-json": {
     "organisation": "@siteimprove",
     "homepage": "https://alfa.siteimprove.com",

docs/review/api/alfa-toolchain.api.md

@@ -4,6 +4,7 @@
 
 ```ts
 
+import { Array as Array_2 } from '@siteimprove/alfa-array';
 import type { ChangelogFunctions } from '@changesets/types';
 import { PackageJSON } from '@changesets/types';
 
@@ -31,7 +32,7 @@ export { individualChangelog }
 function validate(cwd: string): Promise<void>;
 
 // @public
-function validateChangesets(cwd: string): Promise<Array<string>>;
+function validateChangesets(cwd: string, forbidMajor?: boolean): Promise<Array_2<string>>;
 
 // Warning: (ae-forgotten-export) The symbol "Config" needs to be exported by the entry point index.d.ts
 //

packages/alfa-toolchain/package.json

@@ -39,6 +39,8 @@
     "@changesets/git": "^2.0.0",
     "@changesets/read": "^0.5.9",
     "@manypkg/get-packages": "=1.1.3",
+    "@siteimprove/alfa-array": "workspace:^0.69.0",
+    "@siteimprove/alfa-option": "workspace:^0.69.0",
     "@siteimprove/alfa-result": "workspace:^0.69.0",
     "@svitejs/changesets-changelog-github-compact": "^1.1.0",
     "resolve-from": "^5.0.0"

packages/alfa-toolchain/src/validation/validate-all.ts

@@ -27,7 +27,9 @@ export async function validate(cwd: string) {
   const packages = await getPackages(cwd);
 
   if (config["validate-changesets"] ?? false) {
-    errors.push(...(await validateChangesets(cwd)));
+    errors.push(
+      ...(await validateChangesets(cwd, config["forbid-major"] ?? false)),
+    );
   }
 
   if (config["has-api-extractor-config"] ?? false) {

packages/alfa-toolchain/src/validation/validate-changesets.ts

@@ -1,4 +1,7 @@
 import getChangeSets from "@changesets/read";
+import { NewChangeset } from "@changesets/types";
+import { Array } from "@siteimprove/alfa-array";
+import { None, Option } from "@siteimprove/alfa-option";
 import { Err, Result } from "@siteimprove/alfa-result";
 
 import { Changeset } from "../changeset/get-changeset-details";
@@ -8,9 +11,36 @@ import { Changeset } from "../changeset/get-changeset-details";
  *
  * @public
  */
-export async function validateChangesets(cwd: string): Promise<Array<string>> {
-  return (await getChangeSets(cwd))
-    .map(Changeset.getDetails)
-    .filter<Err<string>>(Result.isErr)
-    .map((err) => err.getErr());
+export async function validateChangesets(
+  cwd: string,
+  forbidMajor: boolean = false,
+): Promise<Array<string>> {
+  const errors: Array<string> = [];
+
+  const changesets = await getChangeSets(cwd);
+
+  errors.push(
+    ...changesets
+      .map(Changeset.getDetails)
+      .filter<Err<string>>(Result.isErr)
+      .map((err) => err.getErr()),
+  );
+
+  if (forbidMajor) {
+    errors.push(
+      ...Array.collect(changesets, (changeset) =>
+        isMajor(changeset)
+          ? Option.of(
+              `Major bumps not allowed while on version 0: ${changeset.id}`,
+            )
+          : None,
+      ),
+    );
+  }
+
+  return errors;
+}
+
+function isMajor(changeset: NewChangeset): boolean {
+  return changeset.releases.some((release) => release.type === "major");
 }

packages/alfa-toolchain/tsconfig.json

@@ -22,6 +22,8 @@
     "test/changeset/get-changeset-details.spec.tsx"
   ],
   "references": [
+    { "path": "../alfa-array" },
+    { "path": "../alfa-option" },
     { "path": "../alfa-result" },
     { "path": "../alfa-test" }
   ]

yarn.lock

@@ -1762,6 +1762,8 @@ __metadata:
     "@changesets/read": "npm:^0.5.9"
     "@changesets/types": "npm:^5.2.1"
     "@manypkg/get-packages": "npm:=1.1.3"
+    "@siteimprove/alfa-array": "workspace:^0.69.0"
+    "@siteimprove/alfa-option": "workspace:^0.69.0"
     "@siteimprove/alfa-result": "workspace:^0.69.0"
     "@siteimprove/alfa-test": "workspace:^0.69.0"
     "@svitejs/changesets-changelog-github-compact": "npm:^1.1.0"