ci: update build script

.github/scripts/build.mjs

@@ -5,7 +5,7 @@ import fss from "fs"
 import paths from "path"
 import url from "url"
 import sgit from "simple-git"
-import metadata from "../source/app/metrics/metadata.mjs"
+import metadata from "../../source/app/metrics/metadata.mjs"
 import yaml from "js-yaml"
 
 //Mode
@@ -13,38 +13,24 @@ const [mode = "dryrun"] = process.argv.slice(2)
 console.log(`Mode: ${mode}`)
 
 //Paths
-const __metrics = paths.join(paths.dirname(url.fileURLToPath(import.meta.url)), "..")
+const __metrics = paths.join(paths.dirname(url.fileURLToPath(import.meta.url)), "../..")
 const __action = paths.join(__metrics, "source/app/action")
 const __web = paths.join(__metrics, "source/app/web")
 const __readme = paths.join(__metrics, ".github/readme")
 const __templates = paths.join(paths.join(__metrics, "source/templates/"))
 const __plugins = paths.join(paths.join(__metrics, "source/plugins/"))
-const __test_plugins = paths.join(paths.join(__metrics, "tests/plugins"))
+const __test_cases = paths.join(paths.join(__metrics, "tests/cases"))
 const __test_secrets = paths.join(paths.join(__metrics, "tests/secrets.json"))
 
 //Git setup
 const git = sgit(__metrics)
 const staged = new Set()
+const secrets = Object.assign(JSON.parse(`${await fs.readFile(__test_secrets)}`), {$regex:/\$\{\{\s*secrets\.(?<secret>\w+)\s*\}\}/})
+const {plugins, templates} = await metadata({log:false, diff:true})
+const workflow = []
 
 //Config and general documentation auto-generation
-for (const step of ["config", "documentation"]) {
+for (const step of []) {
-
-  //Load plugins metadata
-  const {plugins, templates, packaged, descriptor} = await metadata({log:false})
-
-  //Update generated files
-  async function update({source, output, options = {}}) {
-    //Regenerate file
-    console.log(`Generating ${output}`)
-    const content = await ejs.renderFile(source, {plugins, templates, packaged, descriptor}, {async:true, ...options})
-    //Save result
-    const file = paths.join(__metrics, output)
-    await fs.writeFile(file, content)
-    //Add to git
-    staged.add(file)
-  }
-
-  //Templating
   switch (step) {
     case "config":
       await update({source:paths.join(__action, "action.yml"), output:"action.yml"})
@@ -58,64 +44,42 @@ for (const step of ["config", "documentation"]) {
   }
 }
 
-{
+//Plugins
-  //Load plugins metadata and secrets
+for (const id of Object.keys(plugins)) {
-  const {plugins, templates} = await metadata({log:false, diff:true})
+  const {examples, options, readme, tests} = await plugin(id)
-  const secrets = Object.assign(JSON.parse(`${await fs.readFile(__test_secrets)}`), {$regex:/\$\{\{\s*secrets\.(?<secret>\w+)\s*\}\}/})
 
-  //Get plugin infos
+  //Readme
-  async function plugin(id) {
+  await fs.writeFile(readme.path, readme.content
-    const path = paths.join(__plugins, id)
+    .replace(/(<!--examples-->)[\s\S]*(<!--\/examples-->)/g, `$1\n${examples.map(({test, prod, ...step}) => ["```yaml", yaml.dump(step), "```"].join("\n")).join("\n")}\n$2`)
-    const readme = paths.join(path, "README.md")
+    .replace(/(<!--options-->)[\s\S]*(<!--\/options-->)/g, `$1\n${options}\n$2`)
-    const examples = paths.join(path, "examples.yml")
+  )
-    const tests = paths.join(__test_plugins, `${id}.yml`)
+  console.log(`Generating source/plugins/${id}/README.md`)
-    return {
-      readme:{
-        path:readme,
-        content:`${await fs.readFile(readme)}`
-      },
-      tests:{
-        path:tests
-      },
-      examples:fss.existsSync(examples) ? yaml.load(await fs.readFile(examples), "utf8") ?? [] : [],
-      options:plugins[id].readme.table
-    }
-  }
-
-  //Plugins
-  for (const id of Object.keys(plugins)) {
-    const {examples, options, readme, tests} = await plugin(id)
-
-    //Plugin readme
-    await fs.writeFile(readme.path, readme.content
-      .replace(/(<!--examples-->)[\s\S]*(<!--\/examples-->)/g, `$1\n${examples.map(({test, prod, ...step}) => ["```yaml", yaml.dump(step), "```"].join("\n")).join("\n")}\n$2`)
-      .replace(/(<!--options-->)[\s\S]*(<!--\/options-->)/g, `$1\n${options}\n$2`)
-    )
-    console.log(`Generating ${readme.path}`)
-
-    //Plugin tests
-    await fs.writeFile(tests.path, yaml.dump(examples.map(({prod, test = {}, name = "", ...step}) => {
-      if (test.skip)
-        return null
-      const result = {name:`${plugins[id].name} - ${name}`, ...step, ...test}
-      test.with ??= {}
-      for (const [k, v] of Object.entries(result.with)) {
-        if (k in test.with)
-          result.with[k] = test.with[k]
-        if (secrets.$regex.test(v))
-          result.with[k] = v.replace(secrets.$regex, secrets[v.match(secrets.$regex)?.groups?.secret])
-      }
-      if (!result.with.base)
-        delete result.with.base
-      delete result.with.filename
-      return result
-    }).filter(t => t)))
-    console.log(`Generating ${tests.path}`)
-
-  }
 
+  //Tests
+  workflow.push(...examples.map(example => testcase(plugins[id].name, "prod", example)).filter(t => t))
+  await fs.writeFile(tests.path, yaml.dump(examples.map(example => testcase(plugins[id].name, "test", example)).filter(t => t)))
+  console.log(`Generating tests/plugins/${id}.yml`)
 }
 
+//Templates
+for (const id of Object.keys(templates)) {
+  const {examples, readme, tests} = await template(id)
+
+  //Readme
+  await fs.writeFile(readme.path, readme.content
+    .replace(/(<!--examples-->)[\s\S]*(<!--\/examples-->)/g, `$1\n${examples.map(({test, prod, ...step}) => ["```yaml", yaml.dump(step), "```"].join("\n")).join("\n")}\n$2`)
+  )
+  console.log(`Generating source/templates/${id}/README.md`)
+
+  //Tests
+  workflow.push(...examples.map(example => testcase(templates[id].name, "prod", example)).filter(t => t))
+  await fs.writeFile(tests.path, yaml.dump(examples.map(example => testcase(templates[id].name, "test", example)).filter(t => t)))
+  console.log(`Generating tests/templates/${id}.yml`)
+}
+
+//Example workflows
+await update({source:paths.join(__metrics, ".github/scripts/files/examples.yml"), output:".github/workflows/examples.yml", context:{steps:yaml.dump(workflow)}})
+
 //Commit and push
 if (mode === "publish") {
   console.log(`Pushing staged changes: \n${[...staged].map(file => `  - ${file}`).join("\n")}`)
@@ -128,3 +92,78 @@ if (mode === "publish") {
   console.log(gitted)
 }
 console.log("Success!")
+
+//==================================================================================
+
+//Update generated files
+async function update({source, output, context = {}, options = {}}) {
+  console.log(`Generating ${output}`)
+  const {plugins, templates, packaged, descriptor} = await metadata({log:false})
+  const content = await ejs.renderFile(source, {plugins, templates, packaged, descriptor, ...context}, {async:true, ...options})
+  const file = paths.join(__metrics, output)
+  await fs.writeFile(file, content)
+  staged.add(file)
+}
+
+//Get plugin infos
+async function plugin(id) {
+  const path = paths.join(__plugins, id)
+  const readme = paths.join(path, "README.md")
+  const examples = paths.join(path, "examples.yml")
+  const tests = paths.join(__test_cases, `${id}.plugin.yml`)
+  return {
+    readme:{
+      path:readme,
+      content:`${await fs.readFile(readme)}`
+    },
+    tests:{
+      path:tests
+    },
+    examples:fss.existsSync(examples) ? yaml.load(await fs.readFile(examples), "utf8") ?? [] : [],
+    options:plugins[id].readme.table
+  }
+}
+
+//Get template infos
+async function template(id) {
+  const path = paths.join(__templates, id)
+  const readme = paths.join(path, "README.md")
+  const examples = paths.join(path, "examples.yml")
+  const tests = paths.join(__test_cases, `${id}.template.yml`)
+  return {
+    readme:{
+      path:readme,
+      content:`${await fs.readFile(readme)}`
+    },
+    tests:{
+      path:tests
+    },
+    examples:fss.existsSync(examples) ? yaml.load(await fs.readFile(examples), "utf8") ?? [] : [],
+  }
+}
+
+//Testcase generator
+function testcase(name, env, {prod = {}, test = {}, ...step}) {
+  const context = {prod, test}[env] ?? {}
+  if (context.skip)
+    return null
+  const result = {...JSON.parse(JSON.stringify(step)), ...context, name:`${name} - ${step.name ?? "(unnamed)"}`}
+  context.with ??= {}
+  for (const [k, v] of Object.entries(result.with)) {
+    if (k in context.with)
+      result.with[k] = context.with[k]
+    if ((env === "test")&&(secrets.$regex.test(v)))
+      result.with[k] = v.replace(secrets.$regex, secrets[v.match(secrets.$regex)?.groups?.secret])
+  }
+  if (!result.with.base)
+    delete result.with.base
+  delete result.with.filename
+
+  if (env === "prod") {
+    result.if = "${{ success() || failure() }}"
+    result.uses = "lowlighter/metrics@master"
+    Object.assign(result.with, {plugins_errors_fatal:"yes", output_action:"none", delay:120})
+  }
+
+  return result
+}

.github/scripts/files/examples.yml

@@ -0,0 +1,107 @@
+name: Examples
+on:
+  schedule:
+    - cron: "0 8 * * *"
+  workflow_dispatch:
+jobs:
+
+# ======================================================================================
+# Examples renders
+# ======================================================================================
+
+  examples:
+    runs-on: ubuntu-latest
+    if: "github.repository == 'lowlighter/metrics'"
+    steps:
+<%- steps.split("\n").map(line => `      ${line}`).join("\n") %>
+
+# ======================================================================================
+# Markdown as png (for readme updates)
+# ======================================================================================
+
+  examples-markdown:
+    runs-on: ubuntu-latest
+    if: false
+    #if: "github.repository == 'lowlighter/metrics'"
+    container: ghcr.io/lowlighter/metrics:master
+    needs: [examples]
+    steps:
+      - name: Screenshot markdown example
+        run: |
+          node /metrics/.github/scripts/markdown_example.mjs
+          echo "METRICS_MARKDOWN_EXAMPLE=$(base64 --wrap=0 metrics.markdown.png)" >> $GITHUB_ENV
+      - name: Update markdown example
+        uses: actions/github-script@v5
+        env:
+          METRICS_MARKDOWN_EXAMPLE: "${{ env.METRICS_MARKDOWN_EXAMPLE }}"
+        with:
+          script: |
+            try {
+              const {data:{sha}} = await github.rest.repos.getContent({...context.repo, path:"metrics.markdown.png"})
+              console.log(`current sha: ${sha}`)
+              github.rest.repos.createOrUpdateFileContents({
+                ...context.repo,
+                path:"metrics.markdown.png",
+                message:`Auto-generated metrics for run #${github.context ? github.context.runId : "0000000000"}`,
+                content:process.env.METRICS_MARKDOWN_EXAMPLE,
+                sha,
+              })
+            } catch (error) { console.log(error) }
+
+# ======================================================================================
+# Special job used to render lowlighter/metrics repository assets
+# ======================================================================================
+
+  repository:
+    runs-on: ubuntu-latest
+    if: "github.repository == 'lowlighter/metrics'"
+    steps:
+      - name: Contributors
+        if: ${{ success() || failure() }}
+        uses: lowlighter/metrics@master
+        with:
+          filename: metrics.contributors.svg
+          token: ${{ secrets.METRICS_TOKEN }}
+          base: ""
+          template: repository
+          user: lowlighter
+          repo: metrics
+          plugin_people: yes
+          plugin_people_types: contributors
+          plugins_errors_fatal: yes
+          config_display: large
+          output_action: none
+          delay: 120
+
+      - name: Sponsors
+        if: ${{ success() || failure() }}
+        uses: lowlighter/metrics@master
+        with:
+          filename: metrics.sponsors.svg
+          token: ${{ secrets.METRICS_TOKEN }}
+          base: ""
+          plugin_people: yes
+          plugin_people_types: sponsors
+          plugin_people_sponsors_custom: yutkat, ktnkk, iamsainikhil, tfSheol
+          plugin_people_size: 48
+          plugins_errors_fatal: ${{ github.repository == 'lowlighter/lowlighter' }}
+          config_display: large
+          output_action: none
+          delay: 120
+
+      - name: Licenses
+        if: ${{ success() || failure() }}
+        uses: lowlighter/metrics@master
+        with:
+          filename: metrics.licenses.svg
+          token: ${{ secrets.METRICS_TOKEN }}
+          base: ""
+          template: repository
+          repo: metrics
+          plugin_licenses: yes
+          plugin_licenses_setup: npm ci
+          plugin_licenses_legal: yes
+          plugin_licenses_ratio: yes
+          plugins_errors_fatal: ${{ github.repository == 'lowlighter/lowlighter' }}
+          output_action: none
+          delay: 120