@hexonet/semantic-release-whmcs 4.0.4 → 5.0.0

package/.github/dependabot.yml

@@ -1,9 +1,9 @@
 version: 2
 updates:
-- package-ecosystem: npm
-  directory: "/"
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 10
-  commit-message:
-    prefix: chore
+  - package-ecosystem: npm
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+    commit-message:
+      prefix: chore

package/.github/workflows/release.yml

@@ -0,0 +1,29 @@
+name: Release
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  release:
+    name: Release @ NodeJS LTS - x86 - ubuntu-latest
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - name: Setup NodeJS LTS
+        uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+          cache: npm
+      - name: Install dependencies
+        run: npm ci
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+          GITHUB_REPO: ${{ secrets.GH_REPO }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

package/.github/workflows/{pull-request.yml → test.yml}

@@ -1,24 +1,21 @@
-# This workflow handle pull requests
-name: Receive pull_request
-on: [pull_request_target]
+name: Lint codebase & Execute tests
+on:
+  push:
+    branches:
+      - dependabot/** #branches are generated by https://github.com/dependabot
+
+  pull_request:
+    types:
+      - opened
+      - synchronize
+
 jobs:
-  approve: # to approve a workflow run(through github environment)
-    name: Approve Job
-    runs-on: ubuntu-latest
-    steps:
-      - name: Approve
-        run: |
-          echo For security reasons, all pull requests need to be approved first before running any automated CI.
-          echo Thank you for your patience.
   test:
     name: Test @ NodeJS - x86 - ubuntu-latest
     runs-on: ubuntu-latest
-    needs: [approve]
     strategy:
       matrix:
         node-version: [lts/*]
-    environment:
-      name: pr-reviews
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -26,7 +23,7 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-          check-latest: true
+          cache: npm
       - name: Install dependencies
         run: npm ci
       - name: Linting
@@ -40,7 +37,7 @@ jobs:
           WHMCSMP_PRODUCTID: ${{ secrets.WHMCSMP_PRODUCTID }}
           WHMCSMP_MINVERSION: ${{ secrets.WHMCSMP_MINVERSION }}
           DEBUG: ${{ secrets.DEBUG }}
-        run: npm run coverage
+        run: npm run test
       - name: Initialize CodeQL
         uses: github/codeql-action/init@v2
         with:

package/.releaserc.json

@@ -12,11 +12,7 @@
     [
       "@semantic-release/git",
       {
-        "assets": [
-          "HISTORY.md",
-          "package?(-lock).json",
-          "coverage"
-        ],
+        "assets": ["HISTORY.md", "package?(-lock).json"],
         "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
       }
     ],

package/HISTORY.md

@@ -1,3 +1,15 @@
+# [5.0.0](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-whmcs/compare/v4.0.4...v5.0.0) (2023-01-18)
+
+
+### chore
+
+* **node:** Refactored SemanticRelease to make it compatible with ESM ([f5a3640](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-whmcs/commit/f5a36404e978d072f60497787074301d34255633))
+
+
+### BREAKING CHANGES
+
+* **node:** Ported to ESM
+
 ## [4.0.4](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-whmcs/compare/v4.0.3...v4.0.4) (2023-01-04)
 
 

package/index.js

@@ -1,9 +1,9 @@
-const verifyWHMCS = require('./lib/verify')
-const publishWHMCS = require('./lib/publish')
-const deleteVersion = require('./lib/delete-marketplace-version')
-const setCompatibleVersions = require('./lib/set-compatible-versions')
-const githubReleases = require('./lib/get-github-releases.js')
-const marketplaceVersions = require('./lib/scrape-marketplace-versions.js')
+import verifyWHMCS from "./lib/verify.js";
+import publishWHMCS from "./lib/publish.js";
+import deleteVersion from "./lib/delete-marketplace-version.js";
+import setCompatibleVersions from "./lib/set-compatible-versions.js";
+import githubReleases from "./lib/get-github-releases.js";
+import marketplaceVersions from "./lib/scrape-marketplace-versions.js";
 
 let verified;
 
@@ -25,46 +25,45 @@ async function verifyConditions(pluginConfig, context) {
  * @param {*} context The context provided by semantic-release
  */
 async function publish(pluginConfig, context) {
-  await verifyConditions(pluginConfig, context)
-  return publishWHMCS(pluginConfig, context)
+  await verifyConditions(pluginConfig, context);
+  return publishWHMCS(pluginConfig, context);
 }
 
 async function syncVersions(pluginConfig, context) {
-  await verifyConditions(pluginConfig, context)
-  const releases = await githubReleases(pluginConfig, context)
+  await verifyConditions(pluginConfig, context);
+  const releases = await githubReleases(pluginConfig, context);
 
   if (releases && releases.length) {
-    const versions = await marketplaceVersions(pluginConfig, context)
+    const versions = await marketplaceVersions(pluginConfig, context);
     for (const release of releases) {
       if (!versions.includes(release.name.substring(1))) {
         context.nextRelease = {
           version: release.name.substring(1),
           notes: release.body,
-          releaseDate: release.published_at
-        }
-        console.log(`Adding missing version ${context.nextRelease.version}`)
-        await publish(pluginConfig, context)
+          releaseDate: release.published_at,
+        };
+        console.log(`Adding missing version ${context.nextRelease.version}`);
+        await publish(pluginConfig, context);
       }
     }
   }
 }
 
-
 async function delVersion(pluginConfig, context) {
-  await verifyConditions(pluginConfig, context)
-  await deleteVersion(pluginConfig, context)
+  await verifyConditions(pluginConfig, context);
+  await deleteVersion(pluginConfig, context);
 }
 
 async function updateCompatibility(pluginConfig, context) {
-  await verifyConditions(pluginConfig, context)
-  await setCompatibleVersions(pluginConfig, context)
+  await verifyConditions(pluginConfig, context);
+  await setCompatibleVersions(pluginConfig, context);
 }
 
 async function fail(pluginConfig, context) {
-  await verifyConditions(pluginConfig, context)
+  await verifyConditions(pluginConfig, context);
 }
 
-module.exports = {
+export default {
   verifyConditions,
   publish,
   fail,
@@ -72,5 +71,5 @@ module.exports = {
   delVersion,
   githubReleases,
   marketplaceVersions,
-  updateCompatibility
-}
+  updateCompatibility,
+};

package/lib/definitions/errors.js

@@ -1,21 +1,30 @@
-module.exports = {
-  ENOGHTOKEN: () => ({
+export function ENOGHTOKEN() {
+  return {
     message: "No Github Token specified.",
     details: "Please create a `GH_TOKEN` in repository secrets.",
-  }),
-  EWHMCSNOCREDENTIALS: () => ({
+  };
+}
+
+export function EWHMCSNOCREDENTIALS() {
+  return {
     message: "No WHMCS Marketplace credentials specified.",
     details:
       "WHMCS Marketplace credentails have to be set in the `WHMCS_LOGIN` and `WHMCS_PASSWORD` environment variables on your CI environment.",
-  }),
-  EWHMCSNOPRODUCTID: () => ({
+  };
+}
+
+export function EWHMCSNOPRODUCTID() {
+  return {
     message: "No WHMCS Marketplace Product ID specified.",
     details:
       "The product id of your listed product at the WHMCS Marketplace has to be set in the `WHMCS_PRODUCTID` environment variable on your CI environment. You'll find that number in url when visiting the product page in WHMCS Marketplace.",
-  }),
-  EWHMCSINVALIDPRODUCTID: () => ({
+  };
+}
+
+export function EWHMCSINVALIDPRODUCTID() {
+  return {
     message: "Invalid WHMCS Marketplace Product ID specified.",
     details:
       "The product id of your listed product at the WHMCS Marketplace has to be set in the `WHMCS_PRODUCTID` environment variable on your CI environment. You'll find that number in url when visiting the product page in WHMCS Marketplace.",
-  }),
-};
+  };
+}

package/lib/delete-marketplace-version.js

@@ -1,40 +1,40 @@
-const debug = require('debug')('semantic-release:whmcs')
-const puppet = require('./puppet')
-const path = require('path')
-
+import puppet from "./puppet.js";
+import debugConfig from "debug";
+import { fileURLToPath } from "node:url";
+const debug = debugConfig("semantic-release:whmcs");
+const __filename = fileURLToPath(import.meta.url);
 /**
  * A method to publish the module update on whmcs market place
  */
-module.exports = async (pluginConfig, context) => {
+export default async (pluginConfig, context) => {
   // if (!context.logger) {
   //    context.logger = console;
   // }
 
-  const sep = '+++++++++++++++++++++++++++++++++++++++++++++++++++'
-  const out = `\n${sep}\n${path.basename(__filename)}\n${sep}\n`
+  const sep = "+++++++++++++++++++++++++++++++++++++++++++++++++++";
+  const out = `\n${sep}\n${__filename}\n${sep}\n`;
 
-  const { version } = context
+  const { version } = context;
   if (!version || !version.length) {
-    debug(`${out}Deleting product version failed. No input data available.`)
-    return false
+    debug(`${out}Deleting product version failed. No input data available.`);
+    return false;
   }
 
-  debug(`${out}Delete Version: ${version}`)
+  debug(`${out}Delete Version: ${version}`);
 
-  const püppi = await puppet(context)
-  const result = await püppi.login()
+  const püppi = await puppet(context);
+  const result = await püppi.login();
   if (!result) {
-    return result
+    return result;
   }
-  const { page, navOpts, gotoOpts, selectorOpts, productid, urlbase } =
-    püppi.config
+  const { page, navOpts, gotoOpts, selectorOpts, productid, urlbase } = püppi.config;
 
   // strip markdown links from notes as not allowed to keep
   try {
     // navigate to product administration
-    const url = `${urlbase}/product/${productid}/edit#versions`
-    await page.goto(url, gotoOpts)
-    debug('product page loaded at %s', url)
+    const url = `${urlbase}/product/${productid}/edit#versions`;
+    await page.goto(url, gotoOpts);
+    debug("product page loaded at %s", url);
     // open versions tab (instead of doing it via url)
     // let selector = '#nav-tabs li a[href="#versions"]';
     // await page.waitForSelector(selector, selectorOpts);
@@ -44,43 +44,43 @@ module.exports = async (pluginConfig, context) => {
     // xpath improvements / changes with v16.1.0
     // -> https://github.com/puppeteer/puppeteer/pull/8730
     // https://github.com/puppeteer/puppeteer/blob/d1681ec06b7c3db4b51c20b17b3339f852efbd4d/test/src/queryhandler.spec.ts
-    let elements = []
+    let elements = [];
     do {
-      const xpath = `xpath/.//td[contains(., "Version ${version}")]/following-sibling::td/a[contains(@class, "btn-styled-red")]`
-      await page.waitForSelector(xpath, selectorOpts)
-      debug('XPath found.')
-      const nav = page.waitForNavigation(navOpts)
-      elements = await page.$$(xpath)
+      const xpath = `xpath/.//td[contains(., "Version ${version}")]/following-sibling::td/a[contains(@class, "btn-styled-red")]`;
+      await page.waitForSelector(xpath, selectorOpts);
+      debug("XPath found.");
+      const nav = page.waitForNavigation(navOpts);
+      elements = await page.$$(xpath);
       if (elements.length) {
-        debug('Delete Button - click.')
-        await elements[0].hover()
-        await elements[0].click()
-        debug('Delete Button - clicked.')
-        await nav
-        debug('Navigation finished.')
+        debug("Delete Button - click.");
+        await elements[0].hover();
+        await elements[0].click();
+        debug("Delete Button - clicked.");
+        await nav;
+        debug("Navigation finished.");
         // confirm deletion
-        const selector = 'button.btn-styled-red'
-        await page.waitForSelector(selector, selectorOpts)
-        debug('deletion confirmation button available')
-        debug('click confirmation button')
-        await page.clickAndNavigate(selector)
-        debug('clicked confirmation button')
-        await nav
-        debug('WHMCS Marketplace deleting product version succeeded.')
+        const selector = "button.btn-styled-red";
+        await page.waitForSelector(selector, selectorOpts);
+        debug("deletion confirmation button available");
+        debug("click confirmation button");
+        await page.clickAndNavigate(selector);
+        debug("clicked confirmation button");
+        await nav;
+        debug("WHMCS Marketplace deleting product version succeeded.");
       }
-    } while (elements.length)
+    } while (elements.length);
   } catch (error) {
     // while loop and having all versions deleted
     if (!/waiting for selector `.\/\//i.test(error.message)) {
-      debug('Deleting product version failed.', error.message)
-      await page.browser().close()
-      return false
+      debug("Deleting product version failed.", error.message);
+      await page.browser().close();
+      return false;
     }
   }
 
-  await page.browser().close()
+  await page.browser().close();
   return {
-    name: 'WHMCS Marketplace Product Version',
-    url: `${urlbase}/product/${productid}`
-  }
-}
+    name: "WHMCS Marketplace Product Version",
+    url: `${urlbase}/product/${productid}`,
+  };
+};

package/lib/get-error.js

@@ -1,7 +1,7 @@
-const SemanticReleaseError = require('@semantic-release/error')
-const ERROR_DEFINITIONS = require('./definitions/errors.js')
+import SemanticReleaseError from "@semantic-release/error";
+import * as ERROR_DEFINITIONS from "./definitions/errors.js";
 
-module.exports = (code) => {
-  const { message, details } = ERROR_DEFINITIONS[code]()
-  return new SemanticReleaseError(message, code, details)
-}
+export default (code) => {
+  const { message, details } = ERROR_DEFINITIONS[code]();
+  return new SemanticReleaseError(message, code, details);
+};

package/lib/get-github-releases.js

@@ -1,6 +1,7 @@
-const debug = require('debug')('semantic-release:whmcs')
-const resolveConfig = require('./resolve-config')
-const GitHub = require('github-api')
+import resolveConfig from "./resolve-config.js";
+import GitHub from "github-api";
+import debugConfig from "debug";
+const debug = debugConfig("semantic-release:whmcs");
 
 // https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting
 // Rate limits to 60 requests/hour per IP for anonymous requests, 5000/hour with authentication
@@ -8,26 +9,24 @@ const GitHub = require('github-api')
 /**
  * A method to get releases from github repository
  */
-module.exports = async (pluginConfig, context) => {
-  debug('Getting releases from GitHub')
+export default async (pluginConfig, context) => {
+  debug("Getting releases from GitHub");
 
-  const { ghrepo, ghtoken } = resolveConfig(context)
+  const { ghrepo, ghtoken } = resolveConfig(context);
 
   const gh = new GitHub({
-    token: ghtoken
-  })
+    token: ghtoken,
+  });
   if (ghrepo) {
     // optional by default false
-    const repo = ghrepo.split('/')
-    const githubReleases = await gh.getRepo(repo[0], repo[1]).listReleases()
+    const repo = ghrepo.split("/");
+    const githubReleases = await gh.getRepo(repo[0], repo[1]).listReleases();
     if (githubReleases.status === 200) {
-      githubReleases.data.forEach((r) =>
-        debug(`Detected GitHub release ${r.name.substring(1)}`)
-      )
-      githubReleases.data.reverse()
-      return githubReleases.data
+      githubReleases.data.forEach((r) => debug(`Detected GitHub release ${r.name.substring(1)}`));
+      githubReleases.data.reverse();
+      return githubReleases.data;
     }
-    debug('Failed to get releases from GitHub')
+    debug("Failed to get releases from GitHub");
   }
-  return false
-}
+  return false;
+};

package/lib/publish.js

@@ -1,22 +1,21 @@
-const debug = require("debug")("semantic-release:whmcs");
-const puppet = require("./puppet");
-const setCompatibleVersions = require("./set-compatible-versions");
-const path = require("path");
+import puppet from "./puppet.js";
+import setCompatibleVersions from "./set-compatible-versions.js";
+import debugConfig from "debug";
+import { fileURLToPath } from "node:url";
+const debug = debugConfig("semantic-release:whmcs");
+const __filename = fileURLToPath(import.meta.url);
 
 /**
  * A method to publish the module update on whmcs market place
  */
-module.exports = async (pluginConfig, context) => {
+export default async (pluginConfig, context) => {
   const sep = "+++++++++++++++++++++++++++++++++++++++++++++++++++";
-  const out = `\n${sep}\n${path.basename(__filename)}\n${sep}\n`;
-
+  const out = `\n${sep}\n${__filename}\n${sep}\n`;
   const {
     nextRelease: { notes, version, releaseDate },
   } = context;
   if (!notes || !notes.length || !version || !version.length) {
-    debug(
-      `${out}Publishing new product version failed. No input data available.`
-    );
+    debug(`${out}Publishing new product version failed. No input data available.`);
     return false;
   }
   // strip markdown links from notes as not allowed to keep (taken from remove-markdown and cleaned up)
@@ -76,9 +75,7 @@ module.exports = async (pluginConfig, context) => {
     );
     debug("form input for description finished.");
 
-    await page.clickAndNavigate(
-      'div.listing-edit-container form button[type="submit"]'
-    );
+    await page.clickAndNavigate('div.listing-edit-container form button[type="submit"]');
     await setCompatibleVersions(pluginConfig, context);
   } catch (error) {
     debug("Publishing new product version failed.", error.message);