@arc-e-tect/api-only-publisher 0.19.0 → 0.19.1

package/README.adoc

@@ -6,7 +6,7 @@
 :source-highlighter: rouge
 // The released version of this component: its snippets use it. The release
 // workflow updates it; do not change it by hand.
-:api-only-publisher-version: 0.19.0
+:api-only-publisher-version: 0.19.1
 
 [NOTE]
 .About this documentation
@@ -490,6 +490,7 @@ Below 1.0 each moves one place down: a major becomes a minor, a minor a patch.
 It is a hint, not a compatibility analysis: it may call a compatible change a major, and the version you choose is yours.
 
 The baseline is built with its own `apionly.yaml` and its own toolchain pin, so it is the document that was released.
+Its `versioning` section is not read: it does not shape a document, the guard takes it from today's `apionly.yaml`, and a key renamed since -- `mainBranch`, now `baseBranch` -- would otherwise stop the baseline from being read at all.
 When that pin cannot be had -- a sealed image carries only today's bundler, and downloading is off -- the baseline is built with today's pin instead, and the reason says so.
 A baseline that cannot be built at all leaves the target `undecided`, saying why.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arc-e-tect/api-only-publisher",
-  "version": "0.19.0",
+  "version": "0.19.1",
   "description": "Builds, packs and publishes API description documents from a library of reusable fragments.",
   "license": "MIT",
   "author": "Arc-E-Tect",

package/src/documents.js

@@ -72,6 +72,21 @@ function exportRef(repoRoot, ref, libRel, into) {
     execFileSync("tar", ["-x", "-f", "-", "-C", into], { input: archive, stdio: ["pipe", "ignore", "pipe"] });
 }
 
+/**
+ * Drop the `versioning` section from a baseline's copy of apionly.yaml.
+ *
+ * It does not shape a document: it only tells the guard where to look, and the guard
+ * reads it from today's configuration. A baseline from before a key in it was renamed
+ * -- `mainBranch`, `baseBranch` since 0.18.5 -- could otherwise not be read at all, and
+ * every target would be left undecided (#123).
+ */
+function withoutVersioning(file) {
+    const document = YAML.parseDocument(fs.readFileSync(file, "utf8"));
+    if (!YAML.isMap(document.contents) || !document.contents.has("versioning")) return;
+    document.contents.delete("versioning");
+    fs.writeFileSync(file, document.toString());
+}
+
 /**
  * Pin each tool of the copy's configuration to what this installation can run: its own
  * pin when that can be had, otherwise the one `current` pins. A baseline released with an
@@ -121,7 +136,9 @@ function targetDocuments(config, targets, { ref = null, repoRoot }) {
         try {
             if (ref === null) exportWorkingTree(repoRoot, libRel, scratch);
             else exportRef(repoRoot, ref, libRel, scratch);
-            copy = load(path.join(scratch, libRel, configRel));
+            const configFile = path.join(scratch, libRel, configRel);
+            if (ref !== null) withoutVersioning(configFile);
+            copy = load(configFile);
             notes = usableToolchain(copy, config, ["openapi", "asyncapi"]);
         } catch (error) {
             for (const target of targets) documents.set(target, { error });