aperx/factorio-clusterio
1
0 Fork 0
mirror of https://github.com/clusterio/clusterio.git synced 2026-11-13 23:14:53 +09:00
Code Issues Packages Projects Releases Wiki Activity

Require an impact for each known compat break

Browse Source 
Entries now explain why end users are not or only minimally affected,
and the docs say which version to key by and point to the breaking
changes decision.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
bbassieandClaude Opus 5.5 committed 2026-10-29 00:45:27 +00:00
1 parent 9bd6effd40
commit 3c2ee3e372
5 files changed
+44 -25
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

scripts/version-compat-breaks.js
+7 -5
View File
@@ -7,9 +7,9 @@
* {
* "2.0.3": {
* "messages": {
* "request FactorioVersionsRequest": { "pr": 1129, "reason": "..." }
* "request FactorioVersionsRequest": { "pr": 1129, "reason": "...", "impact": "..." }
* },
* "connect": { "pr": 1234, "reason": "..." }
* "connect": { "pr": 1234, "reason": "...", "impact": "..." }
* }
* }
*
@@ -30,10 +30,12 @@ function validateBreak(value, where) {
if (!Number.isInteger(value.pr) || value.pr <= 0) {
throw new Error(`${where} must have a pr number`);
}
if (typeof value.reason !== "string" || !value.reason.trim()) {
throw new Error(`${where} must have a reason`);
for (const key of ["reason", "impact"]) {
if (typeof value[key] !== "string" || !value[key].trim()) {
throw new Error(`${where} is missing ${key}`);
}
}
const unknown = Object.keys(value).filter(key => !["pr", "reason"].includes(key));
const unknown = Object.keys(value).filter(key => !["pr", "reason", "impact"].includes(key));
if (unknown.length) {
throw new Error(`${where} has unknown properties ${unknown.join(", ")}`);
}