Call the mega-linter-runner installer to generate the examples in the docs

README.md

@@ -421,6 +421,8 @@ In your repository you should have a `.github/workflows` folder with **GitHub**
 <details>
 <summary>This file should have this code</summary>
 
+<!-- The following code has been @generated by build.sh and the mega-linter-runner generator, please don't update it, but update the template, then build again -->
+<!-- install-github-example-workflow-section-start -->
 ```yml
 ---
 # MegaLinter GitHub Action configuration file
@@ -514,6 +516,7 @@ jobs:
           commit_user_name: megalinter-bot
           commit_user_email: [email protected]
 ```
+<!-- install-github-example-workflow-section-end -->
 
 </details>
 

build.sh

@@ -1,6 +1,9 @@
 #!/usr/bin/env bash
 set -eu
 
+npm install --prefix mega-linter-runner
+npm run --prefix mega-linter-runner generator-samples
+
 PYTHONPATH=.
 export PYTHONPATH
 if type python3 >/dev/null 2>/dev/null; then

mega-linter-runner/__tests__/mega-linter.mjs

@@ -0,0 +1,47 @@
+import helpers, { RunResult, result } from "yeoman-test";
+import MyGenerator from "../generators/mega-linter/index.js";
+
+import { dirname } from "path";
+import { fileURLToPath } from "url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+import * as path from "path";
+
+describe("generator test", () => {
+  describe("test", () => {
+    beforeEach(async () => {
+      const files = {
+        "mega-linter-runner/generators/mega-linter/templates/mega-linter.yml":
+          {},
+      };
+      await helpers
+        .run(MyGenerator, {
+          targetDir: RunResult,
+          resolved: path.join(__dirname, "..", "generators", "mega-linter"),
+          namespace: "mega-linter-runner:mega-linter",
+        })
+        .withAnswers({ flavor: "all", ox: false, ci: "gitHubActions" });
+    });
+
+    it("creates files", () => {
+      // before(() => helpers.prepareTemporaryDir());
+      result
+        .dumpFiles(".github/workflows/mega-linter.yml")
+        .fs.copy(
+          ".github/workflows/mega-linter.yml",
+          path.join(
+            __dirname,
+            "..",
+            "generators",
+            "mega-linter",
+            "out",
+            ".github/workflows/mega-linter.yml"
+          )
+        );
+      result.fs.commit();
+      result.dumpFilenames();
+    });
+  });
+});

mega-linter-runner/generators/mega-linter/index.js

@@ -195,9 +195,9 @@ When you don't know what option to select, please use default values`
       this.validateAllCodeBaseGha = "true";
     } else {
       this.validateAllCodeBaseGha  = ">-\n"
-      this.validateAllCodeBaseGha += "            ${{";
-      this.validateAllCodeBaseGha += "              github.event_name == 'push' &&"
-      this.validateAllCodeBaseGha += "              github.ref == 'refs/heads/main'"
+      this.validateAllCodeBaseGha += "            ${{\n";
+      this.validateAllCodeBaseGha += "              github.event_name == 'push' &&\n"
+      this.validateAllCodeBaseGha += "              github.ref == 'refs/heads/main'\n"
       this.validateAllCodeBaseGha += "            }}";
     }
     this.disable = false;

mega-linter-runner/package.json

@@ -16,7 +16,8 @@
     "mega-linter-runner": "lib/index.js"
   },
   "scripts": {
-    "test": "mocha \"test/**/*.test.js\""
+    "test": "mocha \"test/**/*.test.js\"",
+    "generator-samples": "mocha \"__tests__/mega-linter.mjs\""
   },
   "keywords": [
     "mega-linter",
@@ -95,7 +96,8 @@
   "devDependencies": {
     "assert": "^2.1.0",
     "eslint": "^8.50.0",
-    "mocha": "^10.2.0"
+    "mocha": "^10.2.0",
+    "yeoman-test": "^8.2.0"
   },
   "resolutions": {
     "semver": "7.5.2"