@eeacms/volto-banner - npm Package Compare versions

Comparing version 3.1.3 to 3.1.4

CHANGELOG.md

@@ -7,2 +7,18 @@ ### Changelog
 
+### [3.1.4](https://github.com/eea/volto-banner/compare/3.1.3...3.1.4) - 29 September 2023
+
+#### :house: Internal changes
+
+- style: lint-staged reorder in package.json [Alin Voinea - [`34a627e`](https://github.com/eea/volto-banner/commit/34a627e703aaacd8a0aeb4fb76dc6cb65bca0acd)]
+
+#### :house: Documentation changes
+
+- docs: Update README and DEVELOP [Alin Voinea - [`3eeaf7a`](https://github.com/eea/volto-banner/commit/3eeaf7a823f0c990e31d139d03037496a22dbc19)]
+- docs: Cleanup Makefile, update DEVELOP documentation, i18n - refs #254894 [valentinab25 - [`004d5ee`](https://github.com/eea/volto-banner/commit/004d5ee73e2478699ad8ef88e9722675c9d30a0d)]
+
+#### :hammer_and_wrench: Others
+
+- test: EN locales, pre-commit fix, feature PRs checks [valentinab25 - [`31d4233`](https://github.com/eea/volto-banner/commit/31d423366277b9473b87ca9c86b653a7f7ae28d4)]
+- i18n: Add en [Alin Voinea - [`eb9b8c9`](https://github.com/eea/volto-banner/commit/eb9b8c9f2b3fdcba108ffd4fd85a514faa837bb1)]
+- test: Update Makefile and docker-compose to align it with Jenkinsfile [valentinab25 - [`5eb4c10`](https://github.com/eea/volto-banner/commit/5eb4c107ba7d2c8491749fd4424c3355e8196757)]
 ### [3.1.3](https://github.com/eea/volto-banner/compare/3.1.2...3.1.3) - 24 July 2023
@@ -9,0 +25,0 @@

cypress.config.js

@@ -5,3 +5,3 @@ const { defineConfig } = require('cypress');
   viewportWidth: 1280,
-  defaultCommandTimeout: 8888,
+  defaultCommandTimeout: 5000,
   chromeWebSecurity: false,
@@ -11,3 +11,3 @@ reporter: 'junit',
   retries: {
-    runMode: 8,
+    runMode: 1,
     openMode: 0,
@@ -14,0 +14,0 @@ },

DEVELOP.md

@@ -5,2 +5,26 @@ # volto-banner
 
+1. Make sure you have `docker` and `docker compose` installed and running on your machine:
+
+    ```Bash
+    git clone https://github.com/eea/volto-banner.git
+    cd volto-banner
+    git checkout -b bugfix-123456 develop
+    make
+    make start
+    ```
+
+1. Wait for `Volto started at 0.0.0.0:3000` meesage
+
+1. Go to http://localhost:3000
+
+1. Initialize git hooks
+
+    ```Bash
+    yarn prepare
+    ```
+
+1. Happy hacking!
+
+### Or add @eeacms/volto-banner to your Volto project
+
 Before starting make sure your development environment is properly set. See [Volto Developer Documentation](https://docs.voltocms.com/getting-started/install/)
@@ -30,3 +54,3 @@
 
-        yarn develop
+        make develop
         yarn
@@ -36,9 +60,6 @@
 
-        docker pull plone
-        docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" plone
+        docker run --pull always -it --rm --name plone -p 8080:8080 -e SITE=Plone plone/plone-backend
 
     ...wait for backend to setup and start - `Ready to handle requests`:
 
-        docker logs -f plone
-
     ...you can also check http://localhost:8080/Plone
@@ -55,1 +76,35 @@
         cd src/addons/volto-banner/
+
+## Cypress
+
+To run cypress locally, first make sure you don't have any Volto/Plone running on ports `8080` and `3000`.
+
+You don't have to be in a `clean-volto-project`, you can be in any Volto Frontend
+project where you added `volto-banner` to `mrs.developer.json`
+
+Go to:
+
+  ```BASH
+  cd src/addons/volto-banner/
+  ```
+
+Start:
+
+  ```Bash
+  make
+  make start
+  ```
+
+This will build and start with Docker a clean `Plone backend` and `Volto Frontend` with `volto-banner` block installed.
+
+Open Cypress Interface:
+
+  ```Bash
+  make cypress-open
+  ```
+
+Or run it:
+
+  ```Bash
+  make cypress-run
+  ```

package.json

 {
   "name": "@eeacms/volto-banner",
-  "version": "3.1.3",
+  "version": "3.1.4",
   "description": "@eeacms/volto-banner: Volto add-on",
@@ -23,4 +23,27 @@ "main": "src/index.js",
     "babel-plugin-transform-class-properties": "^6.24.1",
+    "husky": "*",
+    "lint-staged": "*",
     "md5": "^2.3.0"
   },
+  "lint-staged": {
+    "src/**/*.{js,jsx,ts,tsx,json}": [
+      "make lint-fix",
+      "make prettier-fix"
+    ],
+    "src/**/*.{jsx}": [
+      "make i18n"
+    ],
+    "theme/**/*.{css,less}": [
+      "make stylelint-fix"
+    ],
+    "src/**/*.{css,less}": [
+      "make stylelint-fix"
+    ],
+    "theme/**/*.overrides": [
+      "make stylelint-fix"
+    ],
+    "src/**/*.overrides": [
+      "make stylelint-fix"
+    ]
+  },
   "scripts": {
@@ -43,4 +66,5 @@ "release": "release-it",
     "cypress:run": "make cypress-run",
-    "cypress:open": "make cypress-open"
+    "cypress:open": "make cypress-open",
+    "prepare": "husky install"
   }
 }

README.md

@@ -36,44 +36,42 @@ # volto-banner
 
-### Start Plone backend with Docker
+### Try volto-banner with Docker
 
-1. Get the latest Docker images
+      git clone https://github.com/eea/volto-banner.git
+      cd volto-banner
+      make
+      make start
 
-   ```
-   docker pull plone
-   docker pull plone/volto
-   ```
+Go to http://localhost:3000
 
-1. Start Plone backend
+### Add volto-banner to your Volto project
 
+1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone
+
+   ```Bash
+   docker compose up backend
    ```
-   docker run -it --rm -p 8080:8080 -e SITE=Plone -e ADDONS="eea.banner" -e PROFILES="profile-eea.banner:default" plone
-   ```
 
-1. Go to http://localhost:3000
-
-### Add volto-banner to your Volto project
-
 1. Start Volto frontend
 
-- If you already have a volto project, just update `package.json`:
+* If you already have a volto project, just update `package.json`:
 
-  ```JSON
-  "addons": [
-      "@eeacms/volto-banner"
-  ],
+   ```JSON
+   "addons": [
+       "@eeacms/volto-banner"
+   ],
 
-  "dependencies": {
-      "@eeacms/volto-banner": "^2.0.0"
-  }
-  ```
+   "dependencies": {
+       "@eeacms/volto-banner": "*"
+   }
+   ```
 
-- If not, create one:
+* If not, create one:
 
-  ```
-  npm install -g yo @plone/generator-volto
-  yo @plone/volto my-volto-project --addon @eeacms/volto-banner
-  cd my-volto-project
-  ```
+   ```
+   npm install -g yo @plone/generator-volto
+   yo @plone/volto my-volto-project --canary --addon @eeacms/volto-banner
+   cd my-volto-project
+   ```
 
-1. Install new add-ons and start Volto:
+1. Install new add-ons and restart Volto:
 
@@ -85,6 +83,6 @@ ```
 
-2. Go to http://localhost:3000
-3. Login `admin:admin`
-4. Go to `Site Setup > Banner settings` and configure your banner
+1. Go to http://localhost:3000
 
+1. Happy editing!
+
 ## Release
@@ -91,0 +89,0 @@

No alert changes

Improved metrics

Total package byte prevSize

47736

increased by11.36%

Number of package files

30

increased by20%

Worsened metrics

Dev dependency count

6

increased by50%

Lines of code

495

decreased by-0.2%

Number of lines in readme file

104

decreased by-1.89%

No dependency changes