Package verify check (#1622)

Author: r0b1n

.github/workflows/BuildJobs.yml

@@ -59,6 +59,8 @@ jobs:
               run: pnpm install
             - name: Lint code
               run: pnpm run lint ${{ env.since_flag }}
+            - name: Verify package format
+              run: pnpm run verify ${{ env.since_flag }}
             - name: Run unit tests
               run: pnpm run test ${{ env.since_flag }}
 

automation/utils/bin/rui-verify-package-format.ts

@@ -10,6 +10,7 @@ import {
 } from "../src";
 import { verify as verifyWidget } from "../src/verify-widget-manifest";
 import { fgCyan, fgGreen, fgYellow } from "../src/ansi-colors";
+import { getModuleChangelog, getWidgetChangelog } from "../src";
 
 async function main(): Promise<void> {
     const path = process.cwd();
@@ -44,6 +45,17 @@ async function main(): Promise<void> {
             }
         }
 
+        switch (info.mxpackage.changelogType ?? info.mxpackage.type) {
+            case "widget": {
+                getWidgetChangelog(path);
+                break;
+            }
+            case "module": {
+                getModuleChangelog(path, info.mxpackage.name);
+                break;
+            }
+        }
+
         if (!info.private) {
             // .private is not true - assume package is published at marketplace
             PublishedPackageSchema.parse(target);

automation/utils/src/changelog-parser/parser/module/module.pegjs

@@ -21,7 +21,7 @@ OtherNotes
 
 // Module
 WidgetSection
-  = _ "###" _ type:(SectionType) _ logs:LogLine* { return { type, logs } }
+  = _ "###" _ type:(SectionType) _ logs:LogLine+ { return { type, logs } }
 
 
 // Subwidgets

automation/utils/src/changelog-parser/parser/widget/widget.pegjs

@@ -3,10 +3,13 @@
 //
 
 ChangelogFile
-  = header:ChangelogHead _ content:(VersionEntry/OtherNotes)+  _ { return { header, content } }
+  = header:ChangelogHead _ content:(UnreleasedVersionEntry/ReleasedVersionEntry/OtherNotes)+  _ { return { header, content } }
 
-VersionEntry
-  = header:(VersionHeader/UnreleasedVersionHeader) _ sections:WidgetSection* _ { return { ...header, sections } }
+UnreleasedVersionEntry
+  = header:(UnreleasedVersionHeader) _ sections:WidgetSection* _ { return { ...header, sections } }
+
+ReleasedVersionEntry
+  = header:(VersionHeader/UnreleasedVersionHeader) _ sections:WidgetSection+ _ { return { ...header, sections } }
 
 VersionHeader
   = "##" _ "[" version:SemVer "]" _ "-" _ date:Date { return { type: "normal", version, date }}
@@ -15,11 +18,11 @@ UnreleasedVersionHeader
   = "##" _ "[Unreleased]" _ { return { type: "unreleased" }}
 
 OtherNotes
-  = "##" _ title:OneLineSentence _ txt:OneLineSentence _ { return { type: "note", title, text: txt }}
+  = "##" _ title:"Older releases" _ txt:OneLineSentence+ _ { return { type: "note", title, text: txt }}
 
-// Logs section #### Changed and its entries
+// Logs section ### Changed, Added, etc and its entries
 WidgetSection
-  = _ "###" _ type:(SectionType) _ logs:LogLine* { return { type, logs } }
+  = _ "###" _ type:(SectionType) _ logs:LogLine+ { return { type, logs } }
 
 LogLine
   = _ "-" _ log:OneLineSentence _ { return log }

automation/utils/src/package-info.ts

@@ -53,6 +53,7 @@ export const MxPackageTypeSchema = z.enum([MODULE, WIDGET, JSACTIONS]);
 export const MxPackageSchema = z.object({
     name: MxPackageNameSchema,
     type: MxPackageTypeSchema,
+    changelogType: z.enum([MODULE, WIDGET]).optional(),
     mpkName: z.string().endsWith(".mpk"),
     dependencies: z.string().array().optional().default([])
 });

package.json

@@ -10,6 +10,7 @@
         "prepare": "husky install",
         "lint": "turbo run lint --continue --concurrency 1",
         "test": "turbo run test --continue --concurrency 1",
+        "verify": "turbo run verify --continue --concurrency 1",
         "build": "turbo run build",
         "release": "turbo run release",
         "create-gh-release": "turbo run create-gh-release --concurrency 1",

packages/pluggableWidgets/charts-web/CHANGELOG.md

@@ -532,6 +532,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - Update `fast-json-patch` dependency.
 
-## Previous versions
+## Older releases
 
 See [marketplace](https://marketplace.mendix.com/link/component/105695) notes.

packages/pluggableWidgets/charts-web/package.json

@@ -12,6 +12,7 @@
     "mxpackage": {
         "name": "Charts",
         "type": "widget",
+        "changelogType": "module",
         "mpkName": "Charts.mpk",
         "dependencies": [
             "@mendix/area-chart-web",

packages/pluggableWidgets/combobox-web/CHANGELOG.md

@@ -154,7 +154,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - We added lazy loading feature. By default it is turned off. When turned on, the items will be loaded in batches when scrolling.
 
-## # Breaking
+### Breaking changes
 
 - The Combo box now uses Atlas variables for its styling. This may change how the widget looks depending on the custom variables.
 

packages/pluggableWidgets/maps-web/CHANGELOG.md

@@ -104,7 +104,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [2.0.3] - 2021-08-04
 
-## Changed
+### Changed
 
 - We renamed Markers and Marker list properties to Static and Dynamic markers.