Merge pull request #204 from pluginpal/feature/strapi-5

Feature/strapi 5

Author: boazpoolman

.changeset/every-lies-glow.md

@@ -0,0 +1,6 @@
+---
+"webtools-addon-sitemap": major
+"strapi-plugin-webtools": major
+---
+
+Strapi 5 support

.changeset/pre.json

@@ -1,5 +1,5 @@
 {
-  "mode": "pre",
+  "mode": "exit",
   "tag": "beta",
   "initialVersions": {
     "@pluginpal/webtools-addon-menus": "0.0.0",

.eslintrc.js

@@ -34,13 +34,21 @@ module.exports = {
         "project": [path.join(__dirname, './tsconfig.jest.json')],
       },
       "rules": {
-        "@typescript-eslint/await-thenable": "off"
+        "@typescript-eslint/await-thenable": "off",
+        "import/no-relative-packages": "off",
       }
     }
   ],
   "rules": {
+    "import/no-unresolved": [2, {
+      "ignore": [
+        "@strapi/strapi/admin",
+        "@strapi/icons/symbols",
+        "@strapi/admin/strapi-admin"
+      ]
+    }],
     "import/prefer-default-export": "off",
     "arrow-body-style": "off",
-    "@typescript-eslint/unbound-method": "off"
+    "@typescript-eslint/unbound-method": "off",
   }
 }

.github/workflows/deploy-test-server.yml

@@ -8,73 +8,73 @@ on:
       - develop
 
 jobs:
-  # preflight-checks:
-  #   name: Preflight checks
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - name: Check if there are config-sync changes on production
-  #       uses: appleboy/ssh-action@v0.1.10
-  #       with:
-  #         host: ${{ secrets.SSH_HOST }}
-  #         username: ${{ secrets.SSH_CI_USERNAME }}
-  #         password: ${{ secrets.SSH_CI_PASSWORD }}
-  #         script_stop: true
-  #         script: dokku run strapi ../node_modules/.bin/config-sync diff
+  preflight-checks:
+    name: Preflight checks
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check if there are config-sync changes on production
+        uses: appleboy/ssh-action@v0.1.10
+        with:
+          host: ${{ secrets.SSH_HOST }}
+          username: ${{ secrets.SSH_CI_USERNAME }}
+          password: ${{ secrets.SSH_CI_PASSWORD }}
+          script_stop: true
+          script: dokku run strapi ../node_modules/.bin/config-sync diff
   deploy:
     name: Deploy
-    # needs: [preflight-checks]
+    needs: [preflight-checks]
     runs-on: ubuntu-latest
     environment:
       name: Test
       url: https://test.pluginpal.io
-  #   steps:
-  #     - name: Checkout repository
-  #       uses: actions/checkout@v2
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
 
-  #     - name: Set up Docker
-  #       uses: actions/setup-node@v3
-  #       with:
-  #         node-version: 18
-  #         cache: 'yarn'
+      - name: Set up Docker
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: 'yarn'
 
-  #     - name: Install plugin dependencies
-  #       run: yarn install
+      - name: Install plugin dependencies
+        run: yarn install
 
-  #     - name: Build the packages
-  #       run: yarn run build
+      - name: Build the packages
+        run: yarn run build
 
-  #     - name: Install de playground dependencies
-  #       run: yarn playground:install
+      - name: Install de playground dependencies
+        run: yarn playground:install
 
-  #     - name: Build a Docker image of the playground
-  #       run: |
-  #         cd playground
-  #         docker build \
-  #           --build-arg PUBLIC_URL=${{ secrets.TEST_URL }} \
-  #           -t strapi-playground:latest .
-  #         docker save -o strapi-playground-latest.tar strapi-playground:latest
+      - name: Build a Docker image of the playground
+        run: |
+          cd playground
+          docker build \
+            --build-arg PUBLIC_URL=${{ secrets.TEST_URL }} \
+            -t strapi-playground:latest .
+          docker save -o strapi-playground-latest.tar strapi-playground:latest
 
-  #     - name: Transfer the Docker image to the Dokku server
-  #       uses: appleboy/scp-action@v0.1.3
-  #       with:
-  #         host: ${{ secrets.SSH_HOST }}
-  #         username: ${{ secrets.SSH_CI_USERNAME }}
-  #         password: ${{ secrets.SSH_CI_PASSWORD }}
-  #         source: playground/strapi-playground-latest.tar
-  #         target: /var/lib/dokku/data/storage/strapi/docker-images
+      - name: Transfer the Docker image to the Dokku server
+        uses: appleboy/scp-action@v0.1.3
+        with:
+          host: ${{ secrets.SSH_HOST }}
+          username: ${{ secrets.SSH_CI_USERNAME }}
+          password: ${{ secrets.SSH_CI_PASSWORD }}
+          source: playground/strapi-playground-latest.tar
+          target: /var/lib/dokku/data/storage/strapi/docker-images
 
-  #     - name: Deploy the Dokku app based on the Docker image
-  #       uses: appleboy/ssh-action@v0.1.10
-  #       with:
-  #         host: ${{ secrets.SSH_HOST }}
-  #         username: ${{ secrets.SSH_CI_USERNAME }}
-  #         password: ${{ secrets.SSH_CI_PASSWORD }}
-  #         script_stop: true
-  #         script: |
-  #           sudo docker load -i /var/lib/dokku/data/storage/strapi/docker-images/playground/strapi-playground-latest.tar
-  #           STRAPI_LATEST_IMAGE=$(sudo docker images --format "{{.ID}}" strapi-playground:latest)
-  #           sudo docker tag strapi-playground:latest strapi-playground:$STRAPI_LATEST_IMAGE
-  #           dokku git:from-image strapi strapi-playground:$STRAPI_LATEST_IMAGE
-  #           sudo docker system prune --all --force
-  #           sudo rm -rf /var/lib/dokku/data/storage/strapi/docker-images/playground/strapi-playground-latest.tar
+      - name: Deploy the Dokku app based on the Docker image
+        uses: appleboy/ssh-action@v0.1.10
+        with:
+          host: ${{ secrets.SSH_HOST }}
+          username: ${{ secrets.SSH_CI_USERNAME }}
+          password: ${{ secrets.SSH_CI_PASSWORD }}
+          script_stop: true
+          script: |
+            sudo docker load -i /var/lib/dokku/data/storage/strapi/docker-images/playground/strapi-playground-latest.tar
+            STRAPI_LATEST_IMAGE=$(sudo docker images --format "{{.ID}}" strapi-playground:latest)
+            sudo docker tag strapi-playground:latest strapi-playground:$STRAPI_LATEST_IMAGE
+            dokku git:from-image strapi strapi-playground:$STRAPI_LATEST_IMAGE
+            sudo docker system prune --all --force
+            sudo rm -rf /var/lib/dokku/data/storage/strapi/docker-images/playground/strapi-playground-latest.tar
 

.github/workflows/tests.yml

@@ -68,7 +68,7 @@ jobs:
         run: yarn test:unit
       - name: Run integration tests
         run: yarn test:integration
-      - name: Run end-to-end tests
+      - name: Run Cypress tests
         uses: cypress-io/github-action@v6
         with:
           start: yarn playground:start
@@ -78,6 +78,12 @@ jobs:
           name: cypress-screenshots
           path: cypress/screenshots
           if-no-files-found: ignore # 'warn' or 'error' are also available, defaults to `warn`
+      - uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: cypress-videos
+          path: cypress/videos
+          if-no-files-found: ignore # 'warn' or 'error' are also available, defaults to `warn`
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v2
         with:

MIGRATION.md

@@ -6,11 +6,11 @@
 <a href="https://docs.pluginpal.io/webtools">Read the documentation</a>
 
 <p>
-  <a href="https://www.npmjs.org/package/@pluginpal/webtools-core">
-    <img src="https://img.shields.io/npm/v/@pluginpal/webtools-core/latest.svg" alt="NPM Version" />
+  <a href="https://www.npmjs.org/package/strapi-plugin-webtools">
+    <img src="https://img.shields.io/npm/v/strapi-plugin-webtools/latest.svg" alt="NPM Version" />
   </a>
-  <a href="https://www.npmjs.org/package/@pluginpal/webtools-core">
-    <img src="https://img.shields.io/npm/dm/@pluginpal/webtools-core" alt="Monthly download on NPM" />
+  <a href="https://www.npmjs.org/package/strapi-plugin-webtools">
+    <img src="https://img.shields.io/npm/dm/strapi-plugin-webtools" alt="Monthly download on NPM" />
   </a>
   <a href="https://codecov.io/gh/pluginpal/strapi-webtools">
     <img src="https://img.shields.io/github/actions/workflow/status/pluginpal/strapi-webtools/tests.yml?branch=master" alt="CI build status" />
@@ -22,9 +22,6 @@
 
 </div>
 
-> [!IMPORTANT]  
-> The Webtools suite is still in BETA
-
 ## ✨ Features
 
 - **Unique URLs** Every page will get their own unique path
@@ -39,10 +36,10 @@
 
 ```bash
 # using yarn
-yarn add @pluginpal/webtools-core
+yarn add strapi-plugin-webtools
 
 # using npm
-npm install @pluginpal/webtools-core --save
+npm install strapi-plugin-webtools --save
 ```
 
 After successful installation you have to rebuild the admin UI so it'll include this plugin. To rebuild and restart Strapi run:
@@ -72,7 +69,7 @@ Webtools can be extended by installing addons that hook into the core Webtools f
 ## 🔗 Links
 
 - [PluginPal marketplace](https://www.pluginpal.io/plugin/webtools)
-- [NPM package](https://www.npmjs.com/package/@pluginpal/webtools-core)
+- [NPM package](https://www.npmjs.com/package/strapi-plugin-webtools)
 - [GitHub repository](https://github.com/pluginpal/strapi-webtools)
 - [Strapi marketplace](https://market.strapi.io/plugins/@pluginpal-webtools-core)
 

README.md

@@ -0,0 +1 @@
+module.exports = { presets: ['@babel/preset-env'] };

babel.config.js

@@ -8,7 +8,8 @@ module.exports = defineConfig({
       // implement node event listeners here.
       require('cypress-terminal-report/src/installLogsPrinter')(on);
     },
-    video: false,
+    video: true,
     defaultCommandTimeout: 10000,
+    requestTimeout: 10000,
   },
 });

cypress.config.js

@@ -1,7 +1,7 @@
 module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
-  testMatch: ['**/__tests__/?(*.)+(spec|test).ts'],
+  testMatch: ['**/__tests__/?(*.)+(spec|test).(ts|js)'],
   // transform: {},
   // globalSetup: './playground/__tests__/setup-strapi.ts',
   // setupFilesAfterEnv: ['./playground/__tests__/setup-strapi.ts'],