GHA to check node versions

Author: AaronFeledy

.github/scripts/check-node-versions.js

@@ -0,0 +1,100 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+const yaml = require('yaml');
+
+/**
+ * Get the required Node.js version from package.json
+ * @returns {string} The Node.js version number
+ */
+function getRequiredNodeVersion() {
+  const packageJson = JSON.parse(fs.readFileSync('package.json', 'utf8'));
+  return packageJson.engines.node.replace('>=', '');
+}
+
+/**
+ * Check Node.js version in .lando.yml
+ * @param {string} requiredVersion - The required Node.js version
+ * @returns {string|null} Mismatch message if version differs, null if matches
+ */
+function checkLandoFile(requiredVersion) {
+  const landoPath = '.lando.yml';
+  const landoContent = fs.readFileSync(landoPath, 'utf8');
+  const landoConfig = yaml.parse(landoContent);
+
+  const currentVersion = landoConfig.services.node.image.split(':')[1];
+  if (currentVersion !== requiredVersion) {
+    return `- .lando.yml has node:${currentVersion}, expected node:${requiredVersion}`;
+  }
+  return null;
+}
+
+/**
+ * Check Node.js version in workflow files
+ * @param {string} requiredVersion - The required Node.js version
+ * @returns {string[]} Array of mismatch messages
+ */
+function checkWorkflowFiles(requiredVersion) {
+  const mismatches = [];
+  const workflowsDir = '.github/workflows';
+
+  const files = fs.readdirSync(workflowsDir)
+      .filter(file => file.endsWith('.yml'));
+
+  files.forEach(file => {
+    const filePath = path.join(workflowsDir, file);
+    const content = fs.readFileSync(filePath, 'utf8');
+    const workflow = yaml.parse(content);
+
+    const checkObject = obj => {
+      for (const key in obj) {
+        if (key === 'node-version' && typeof obj[key] === 'string') {
+          const version = obj[key].replace(/['"]/g, '');
+          if (version !== requiredVersion) {
+            mismatches.push(`- ${filePath} has Node.js ${version}, expected ${requiredVersion}`);
+          }
+        } else if (typeof obj[key] === 'object' && obj[key] !== null) {
+          checkObject(obj[key]);
+        }
+      }
+    };
+
+    checkObject(workflow);
+  });
+
+  return mismatches;
+}
+
+/**
+ * Main function to check Node.js versions
+ */
+function main() {
+  try {
+    const requiredVersion = getRequiredNodeVersion();
+    console.log(`Checking for Node.js version ${requiredVersion} across configuration files...`);
+
+    const mismatches = [];
+
+    const landoMismatch = checkLandoFile(requiredVersion);
+    if (landoMismatch) mismatches.push(landoMismatch);
+
+    const workflowMismatches = checkWorkflowFiles(requiredVersion);
+    mismatches.push(...workflowMismatches);
+
+    if (mismatches.length > 0) {
+      console.error('\nNode.js version mismatches found:');
+      console.error(mismatches.join('\n'));
+      console.error('\nPlease update all Node.js versions to match package.json');
+      process.exit(1);
+    } else {
+      console.log('All Node.js versions match package.json ✓');
+      process.exit(0);
+    }
+  } catch (error) {
+    console.error('Error:', error);
+    process.exit(1);
+  }
+}
+
+main();

.github/workflows/pr-integration-tests.yml

@@ -1,4 +1,4 @@
-name: Integration Tests (Leia)
+name: Integration Tests (Examples)
 
 on:
   pull_request:
@@ -19,7 +19,7 @@ jobs:
         os:
           - ubuntu-24.04
         node-version:
-          - '18'
+          - '20'
     steps:
       - name: Checkout code
         uses: actions/checkout@v4

.github/workflows/pr-node-version-check.yml

@@ -0,0 +1,23 @@
+name: Check Node.js Versions
+
+on:
+  pull_request:
+
+jobs:
+  check-node-versions:
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Install dependencies
+        run: npm install yaml
+
+      - name: Check Node.js versions
+        run: .github/scripts/check-node-versions.js

.github/workflows/pr-unit-tests.yml

@@ -2,6 +2,7 @@ name: Run Unit Tests
 
 on:
   pull_request:
+  workflow_dispatch:
 
 jobs:
   unit-tests:

.lando.yml

@@ -3,7 +3,7 @@ name: lando-mailpit-plugin
 services:
   node:
     type: lando
-    image: node:18
+    image: node:20
     build:
       - npm install
     scanner: false

.nvmrc

@@ -1 +1 @@
-18
+20

CHANGELOG.md

@@ -0,0 +1,7 @@
+## {{ UNRELEASED_VERSION }} - [{{ UNRELEASED_DATE }}]({{ UNRELEASED_LINK }})
+
+- Added CI check to ensure all Node.js versions match package.json.
+
+## v1.0.0-beta.1 - [October 29, 2024](https://github.com/lando/mailpit/releases/tag/v1.0.0-beta.1)
+
+- Initial release of the Mailpit integration plugin for Lando.

README.md

@@ -1,27 +1,61 @@
-# Mailpit Plugin for Lando
-A [Mailpit](https://mailpit.axllent.org) integration plugin for Lando.
+# Mailpit Integration Plugin for Lando
+The official [Mailpit](https://mailpit.axllent.org) integration plugin for [Lando](https://lando.dev).
 
 This is a work in progress. PRs and feedback are appreciated!
 
+## Planned Features
+
+- [x] A Mailpit service for receiving emails.
+- [x] Mailpit UI accessible at http and https routes.
+- [x] Automatic configuration of services to send mail to Mailpit.
+- [x] Automatic installation of Mailpit sendmail client and configuration into services that need it.
+- [ ] Automatic proxy configuration for the Mailpit UI.
+- [ ] A global mailpit service that multiple apps can use.
+- [ ] A `lando mailpit` command that interacts with the mailpit service.
+- [ ] Automatic configuration of popular frameworks to send mail to Mailpit.
+- [ ] Add a mailpit service to a recipe with a single line of configuration.
+
 ## Installation
 
 Install the Mailpit plugin:
 ```bash
 lando plugin-add @lando/mailpit
 ```
 
-Add a mailpit service to your project:
+Add a mailpit service to your landofile:
 ```yaml
+name: mysite
 services:
   mailpit:
     type: mailpit
-    mailFrom:
+    mailFrom: # Optional. The services to send mail from. Defaults to appserver.
       - appserver
+
+proxy:
+  mailpit:
+    - mailpit.mysite.lndo.site
+```
+
+Send mail from your app:
+```php
+<?php
+$to = 'recipient@example.com';
+$subject = 'Test email from My App';
+$message = 'This is a test email sent via PHP.';
+$headers = [
+    'From: sender@example.com',
+    'Content-Type: text/plain; charset=utf-8'
+];
+
+mail($to, $subject, $message, implode("\r\n", $headers));
+
+// The email will be captured by Mailpit and viewable at:
+// http://mailpit.mysite.lndo.site
 ```
 
-## Developer Information
+## Contributing
 
-To get started with this project, follow these steps:
+To get started with contributing to this project, follow these steps:
 
 1. Clone the repository:
    ```bash
@@ -35,7 +69,7 @@ To get started with this project, follow these steps:
    ```
 
 3. Set up your development environment:
-   - Ensure you have Node.js 18 or later installed.
+   - Ensure you have Node.js 20 or later installed.
    - If you're using VS Code, consider installing the ESLint extension for real-time linting feedback.
 
 4. Run the tests to verify the current state of the project:
@@ -50,9 +84,10 @@ Now you're ready to start developing! Check the issues page for tasks to work on
 This repository is structured as follows:
 
 - `builders/`: Contains the main service builder for the Mailpit plugin.
-- `config/`: Contains configuration files used by the Mailpit plugin.
+- `config/`: Contains configuration files used in services managed by the Mailpit plugin.
 - `test/`: Contains unit test files.
 - `examples/`: Example configurations and usage scenarios executed by Leia for testing.
+- `utils/`: Utility functions used by the Mailpit plugin.
 
 ### Linting