Merge pull request #25 from nordeck/nic/feat/make-repository-more-generic

Refactor the repository to be able to host more element modules

Author: dhenneke

.changeset/soft-shoes-kiss.md

@@ -48,7 +48,7 @@ jobs:
     timeout-minutes: 15
     defaults:
       run:
-        working-directory: ./synapse-guest-module/
+        working-directory: ./packages/synapse-guest-module/
     env:
       DOCKER_IMAGE: ghcr.io/nordeck/synapse-guest-module
     steps:
@@ -98,7 +98,7 @@ jobs:
         id: dockerBuild
         with:
           push: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' || github.event_name == 'pull_request' && secrets.GH_APP_OS_APP_ID != '' }}
-          context: synapse-guest-module
+          context: packages/synapse-guest-module
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           platforms: linux/amd64,linux/arm64,linux/s390x

.github/workflows/ci.yml

@@ -1,6 +1,6 @@
 {
   "name": "e2e",
-  "description": "End-to-end tests for element-web-guest-module",
+  "description": "End-to-end tests for element-web-modules",
   "author": "Nordeck IT + Consulting GmbH",
   "license": "Apache-2.0",
   "version": "0.0.0",
@@ -18,7 +18,7 @@
   },
   "scripts": {
     "clean": "echo \"Nothing to clean\"",
-    "build": "yarn workspace @nordeck/element-web-guest-module build && yarn workspace @nordeck/element-web-guest-module package && shx cp ../element-web-guest-module/*.tgz src/deploy/elementWeb/module.tgz && yarn workspace @nordeck/synapse-guest-module docker:build",
+    "build": "yarn workspace @nordeck/element-web-guest-module build && yarn workspace @nordeck/element-web-guest-module package && shx rm -rf src/deploy/elementWeb/*.tgz && shx cp ../packages/element-web-guest-module/*.tgz src/deploy/elementWeb/element-web-guest-module.tgz && yarn workspace @nordeck/synapse-guest-module docker:build",
     "docker:build": "echo \"Nothing to build\"",
     "tsc": "tsc",
     "lint": "eslint . --max-warnings=0",

README.md

@@ -10,7 +10,7 @@ RUN git clone --depth 1 --branch $ELEMENT_VERSION https://github.com/vector-im/e
 RUN yarn --network-timeout=200000 install
 
 # Add all configurations
-COPY /module.tgz /src
+COPY /*.tgz /src
 COPY /build_config.yaml /src
 COPY /customisations.json /src
 

e2e/package.json

@@ -1,3 +1,3 @@
 # Register the module that was created by `yarn build`
 modules:
-  - 'file:module.tgz'
+  - 'file:element-web-guest-module.tgz'

e2e/src/deploy/elementWeb/Dockerfile

@@ -36,8 +36,8 @@ export class LoginFormPage {
   async continueAsGuest(name: string) {
     await this.nameInput.fill(name);
     await Promise.all([
-      this.continueButton.click(),
       this.loadingSpinner.waitFor(),
+      this.continueButton.click(),
     ]);
     await expect(this.loadingSpinner).toBeHidden();
   }

e2e/src/deploy/elementWeb/build_config.yaml

@@ -19,5 +19,5 @@
  * running jest from the root directory.
  */
 module.exports = {
-  projects: ['<rootDir>/element-web-guest-module'],
+  projects: ['<rootDir>/packages/*'],
 };

e2e/src/pages/loginFormPage.ts

@@ -2,8 +2,7 @@
   "name": "root",
   "private": true,
   "workspaces": [
-    "element-web-guest-module",
-    "synapse-guest-module",
+    "packages/*",
     "e2e"
   ],
   "scripts": {

jest.config.js

@@ -1,5 +1,5 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
 
-  "extends": "../api-extractor.json"
+  "extends": "../../api-extractor.json"
 }

package.json

@@ -48,8 +48,8 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/nordeck/element-web-guest-module",
-    "directory": "element-web-guest-module"
+    "url": "https://github.com/nordeck/element-web-modules",
+    "directory": "packages/element-web-guest-module"
   },
   "files": [
     "build",

element-web-guest-module/CHANGELOG.md packages/element-web-guest-module/CHANGELOG.md

@@ -1,5 +1,5 @@
 {
-  "extends": "../tsconfig.json",
+  "extends": "../../tsconfig.json",
   "compilerOptions": {
     "outDir": "lib",
     "rootDir": "."

element-web-guest-module/LICENSE packages/element-web-guest-module/LICENSE

@@ -25,7 +25,7 @@ const path = require('path');
 const child_process = require('child_process');
 
 const cwd = path.resolve(__dirname, '..');
-const venvPath = path.resolve(__dirname, '../../.venv');
+const venvPath = path.resolve(__dirname, '../../../.venv');
 const venvRelativeToCwd = path.relative(cwd, venvPath);
 
 function run(command) {
@@ -47,7 +47,7 @@ async function main() {
   if (!fs.existsSync(venvPath) || !fs.lstatSync(venvPath).isDirectory()) {
     child_process.execSync(`python3 -m venv ${venvRelativeToCwd}`, { cwd });
     await run('pip install tox');
-    await run('pip install -e ."[env]"');
+    await run('pip install -e ."[dev]"');
   }
 
   const command = process.argv.slice(2).join(' ');

element-web-guest-module/README.md packages/element-web-guest-module/README.md

@@ -18,18 +18,25 @@ const fs = require('fs');
 const path = require('path');
 const child_process = require('child_process');
 
-const packages = ['element-web-guest-module'];
+const packages = fs.readdirSync('packages');
 
 for (let p of packages) {
-  const packagePath = path.resolve('./', p);
+  const packagePath = path.resolve('packages', p);
 
   if (!fs.lstatSync(packagePath).isDirectory()) {
     continue;
   }
 
-  const { name, version } = JSON.parse(
-    fs.readFileSync(path.resolve(packagePath, 'package.json')),
-  );
+  const {
+    name,
+    version,
+    private: isPrivate,
+  } = JSON.parse(fs.readFileSync(path.resolve(packagePath, 'package.json')));
+
+  if (isPrivate) {
+    console.log(`🆗 Package ${name} is private`);
+    continue;
+  }
 
   if (!versionNeedsUpload(name, version)) {
     console.log(`✅ Package ${name} already up-to-date`);

element-web-guest-module/api-extractor.json packages/element-web-guest-module/api-extractor.json

@@ -22,7 +22,7 @@ const child_process = require('child_process');
 console.log(child_process.execSync('yarn changeset version').toString());
 
 // Updates the new version in the synapse-guest-module/setup.cfg
-const packagePath = path.resolve('./', 'synapse-guest-module');
+const packagePath = path.resolve('packages', 'synapse-guest-module');
 
 const { version } = JSON.parse(
   fs.readFileSync(path.resolve(packagePath, 'package.json')),

element-web-guest-module/build.js packages/element-web-guest-module/build.js

@@ -19,5 +19,5 @@
   },
   "exclude": ["node_modules"],
   // Include all source code for building
-  "include": ["element-web-guest-module/src", "e2e/src"]
+  "include": ["packages/*/src", "e2e/src"]
 }