@eeacms/volto-editing-progress 0.2.2 → 0.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/DEVELOP.md +56 -0
  3. package/README.md +41 -36
  4. package/docker-compose.yml +32 -0
  5. package/locales/de/LC_MESSAGES/volto.po +17 -0
  6. package/locales/en/LC_MESSAGES/volto.po +17 -0
  7. package/locales/it/LC_MESSAGES/volto.po +17 -0
  8. package/locales/ro/LC_MESSAGES/volto.po +17 -0
  9. package/locales/volto.pot +19 -0
  10. package/package.json +14 -10
  11. package/.i18n.babel.config.js +0 -1
package/CHANGELOG.md CHANGED
@@ -4,6 +4,19 @@ All notable changes to this project will be documented in this file. Dates are d
4
4
 
5
5
  Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
6
6
 
7
+ ### [0.2.3](https://github.com/eea/volto-editing-progress/compare/0.2.2...0.2.3) - 30 August 2023
8
+
9
+ #### :house: Documentation changes
10
+
11
+ - docs: add demo gif - refs #253277 [ana-oprea - [`a42702f`](https://github.com/eea/volto-editing-progress/commit/a42702f0a101694e699f79bf864fd264e6d753a0)]
12
+ - docs: Cleanup Makefile, update DEVELOP documentation, i18n - refs #254894 [valentinab25 - [`1371828`](https://github.com/eea/volto-editing-progress/commit/1371828670a3ccf59a79e19673282d3e17bd1ae1)]
13
+
14
+ #### :hammer_and_wrench: Others
15
+
16
+ - test: Fix package.json scripts to use makefile [Alin Voinea - [`0bd609b`](https://github.com/eea/volto-editing-progress/commit/0bd609b8007a86bd5908a2742048eb7a1580eb5e)]
17
+ - test: Fix eslint and yarn i18n [Alin Voinea - [`ae98cf5`](https://github.com/eea/volto-editing-progress/commit/ae98cf564f2f509a22872b4c715c34d1d10e7e2c)]
18
+ - i18n: Add en [Alin Voinea - [`401d698`](https://github.com/eea/volto-editing-progress/commit/401d69829f547362209afbecacb3842788e123f7)]
19
+ - test: Update Makefile and docker-compose to align it with Jenkinsfile [valentinab25 - [`5bef992`](https://github.com/eea/volto-editing-progress/commit/5bef9923d23f7131f49ec393ce1581dfb3a24d2a)]
7
20
  ### [0.2.2](https://github.com/eea/volto-editing-progress/compare/0.2.1...0.2.2) - 24 July 2023
8
21
 
9
22
  #### :hammer_and_wrench: Others
package/DEVELOP.md CHANGED
@@ -2,6 +2,28 @@
2
2
 
3
3
  ## Develop
4
4
 
5
+ 1. Make sure you have `docker` and `docker compose` installed and running on your machine:
6
+
7
+ ```Bash
8
+ git clone https://github.com/eea/volto-editing-progress.git
9
+ cd volto-editing-progress
10
+ git checkout -b bugfix-123456 develop
11
+ make
12
+ make start
13
+ ```
14
+
15
+ 1. Wait for `Volto started at 0.0.0.0:3000` meesage
16
+
17
+ 1. Go to http://localhost:3000
18
+
19
+ 1. Happy hacking!
20
+
21
+ ```Bash
22
+ cd src/addons/volto-editing-progress/
23
+ ```
24
+
25
+ ### Or add @eeacms/volto-editing-progress to your Volto project
26
+
5
27
  Before starting make sure your development environment is properly set. See [Volto Developer Documentation](https://docs.voltocms.com/getting-started/install/)
6
28
 
7
29
  1. Make sure you have installed `yo`, `@plone/generator-volto` and `mrs-developer`
@@ -49,3 +71,37 @@ Before starting make sure your development environment is properly set. See [Vol
49
71
  1. Happy hacking!
50
72
 
51
73
  cd src/addons/volto-editing-progress/
74
+
75
+ ## Cypress
76
+
77
+ To run cypress locally, first make sure you don't have any Volto/Plone running on ports `8080` and `3000`.
78
+
79
+ You don't have to be in a `clean-volto-project`, you can be in any Volto Frontend
80
+ project where you added `volto-editing-progress` to `mrs.developer.json`
81
+
82
+ Go to:
83
+
84
+ ```BASH
85
+ cd src/addons/volto-editing-progress/
86
+ ```
87
+
88
+ Start:
89
+
90
+ ```Bash
91
+ make
92
+ make start
93
+ ```
94
+
95
+ This will build and start with Docker a clean `Plone backend` and `Volto Frontend` with `volto-editing-progress` block installed.
96
+
97
+ Open Cypress Interface:
98
+
99
+ ```Bash
100
+ make cypress-open
101
+ ```
102
+
103
+ Or run it:
104
+
105
+ ```Bash
106
+ make cypress-run
107
+ ```
package/README.md CHANGED
@@ -14,13 +14,14 @@
14
14
  [![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-editing-progress-develop&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-editing-progress-develop)
15
15
  [![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-editing-progress-develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-editing-progress-develop)
16
16
 
17
-
18
17
  [Volto](https://github.com/plone/volto) add-on: Editing progress
19
18
 
20
19
  ## Features
21
20
 
22
21
  Document Editing progress bar in Volto
23
22
 
23
+ ![Editing Progress](https://raw.githubusercontent.com/eea/volto-editing-progress/master/docs/volto-editing-progress.gif)
24
+
24
25
  ## Getting started
25
26
 
26
27
  ### Try volto-editing-progress with Docker
@@ -33,6 +34,7 @@ Document Editing progress bar in Volto
33
34
  ```
34
35
 
35
36
  1. Start Plone backend
37
+
36
38
  ```
37
39
  docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" plone
38
40
  ```
@@ -49,27 +51,31 @@ Document Editing progress bar in Volto
49
51
 
50
52
  1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone
51
53
 
54
+ ```Bash
55
+ docker compose up backend
56
+ ```
57
+
52
58
  1. Start Volto frontend
53
59
 
54
- * If you already have a volto project, just update `package.json`:
60
+ - If you already have a volto project, just update `package.json`:
55
61
 
56
- ```JSON
57
- "addons": [
58
- "@eeacms/volto-editing-progress"
59
- ],
62
+ ```JSON
63
+ "addons": [
64
+ "@eeacms/volto-editing-progress"
65
+ ],
60
66
 
61
- "dependencies": {
62
- "@eeacms/volto-editing-progress": "^1.0.0"
63
- }
64
- ```
67
+ "dependencies": {
68
+ "@eeacms/volto-editing-progress": "^1.0.0"
69
+ }
70
+ ```
65
71
 
66
- * If not, create one:
72
+ - If not, create one:
67
73
 
68
- ```
69
- npm install -g yo @plone/generator-volto
70
- yo @plone/volto my-volto-project --addon @eeacms/volto-editing-progress
71
- cd my-volto-project
72
- ```
74
+ ```
75
+ npm install -g yo @plone/generator-volto
76
+ yo @plone/volto my-volto-project --addon @eeacms/volto-editing-progress
77
+ cd my-volto-project
78
+ ```
73
79
 
74
80
  1. Install new add-ons and restart Volto:
75
81
 
@@ -86,24 +92,24 @@ Document Editing progress bar in Volto
86
92
 
87
93
  ### Automatic release using Jenkins
88
94
 
89
- * The automatic release is started by creating a [Pull Request](../../compare/master...develop) from `develop` to `master`. The pull request status checks correlated to the branch and PR Jenkins jobs need to be processed successfully. 1 review from a github user with rights is mandatory.
90
- * It runs on every commit on `master` branch, which is protected from direct commits, only allowing pull request merge commits.
91
- * The automatic release is done by [Jenkins](https://ci.eionet.europa.eu). The status of the release job can be seen both in the Readme.md badges and the green check/red cross/yellow circle near the last commit information. If you click on the icon, you will have the list of checks that were run. The `continuous-integration/jenkins/branch` link goes to the Jenkins job execution webpage.
92
- * Automated release scripts are located in the `eeacms/gitflow` docker image, specifically [js-release.sh](https://github.com/eea/eea.docker.gitflow/blob/master/src/js-release.sh) script. It uses the `release-it` tool.
93
- * As long as a PR request is open from develop to master, the PR Jenkins job will automatically re-create the CHANGELOG.md and package.json files to be production-ready.
94
- * The version format must be MAJOR.MINOR.PATCH. By default, next release is set to next minor version (with patch 0).
95
- * You can manually change the version in `package.json`. The new version must not be already present in the tags/releases of the repository, otherwise it will be automatically increased by the script. Any changes to the version will trigger a `CHANGELOG.md` re-generation.
96
- * Automated commits and commits with [JENKINS] or [YARN] in the commit log are excluded from `CHANGELOG.md` file.
95
+ - The automatic release is started by creating a [Pull Request](../../compare/master...develop) from `develop` to `master`. The pull request status checks correlated to the branch and PR Jenkins jobs need to be processed successfully. 1 review from a github user with rights is mandatory.
96
+ - It runs on every commit on `master` branch, which is protected from direct commits, only allowing pull request merge commits.
97
+ - The automatic release is done by [Jenkins](https://ci.eionet.europa.eu). The status of the release job can be seen both in the Readme.md badges and the green check/red cross/yellow circle near the last commit information. If you click on the icon, you will have the list of checks that were run. The `continuous-integration/jenkins/branch` link goes to the Jenkins job execution webpage.
98
+ - Automated release scripts are located in the `eeacms/gitflow` docker image, specifically [js-release.sh](https://github.com/eea/eea.docker.gitflow/blob/master/src/js-release.sh) script. It uses the `release-it` tool.
99
+ - As long as a PR request is open from develop to master, the PR Jenkins job will automatically re-create the CHANGELOG.md and package.json files to be production-ready.
100
+ - The version format must be MAJOR.MINOR.PATCH. By default, next release is set to next minor version (with patch 0).
101
+ - You can manually change the version in `package.json`. The new version must not be already present in the tags/releases of the repository, otherwise it will be automatically increased by the script. Any changes to the version will trigger a `CHANGELOG.md` re-generation.
102
+ - Automated commits and commits with [JENKINS] or [YARN] in the commit log are excluded from `CHANGELOG.md` file.
97
103
 
98
104
  ### Manual release from the develop branch ( beta release )
99
105
 
100
106
  #### Installation and configuration of release-it
101
107
 
102
- You need to first install the [release-it](https://github.com/release-it/release-it) client.
108
+ You need to first install the [release-it](https://github.com/release-it/release-it) client.
103
109
 
104
- ```
105
- npm install -g release-it
106
- ```
110
+ ```
111
+ npm install -g release-it
112
+ ```
107
113
 
108
114
  Release-it uses the configuration written in the [`.release-it.json`](./.release-it.json) file located in the root of the repository.
109
115
 
@@ -116,15 +122,15 @@ Release-it is a tool that automates 4 important steps in the release process:
116
122
 
117
123
  To configure the authentification, you need to export GITHUB_TOKEN for [GitHub](https://github.com/settings/tokens)
118
124
 
119
- ```
120
- export GITHUB_TOKEN=XXX-XXXXXXXXXXXXXXXXXXXXXX
121
- ```
125
+ ```
126
+ export GITHUB_TOKEN=XXX-XXXXXXXXXXXXXXXXXXXXXX
127
+ ```
122
128
 
123
- To configure npm, you can use the `npm login` command or use a configuration file with a TOKEN :
129
+ To configure npm, you can use the `npm login` command or use a configuration file with a TOKEN :
124
130
 
125
- ```
126
- echo "//registry.npmjs.org/:_authToken=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYY" > .npmrc
127
- ```
131
+ ```
132
+ echo "//registry.npmjs.org/:_authToken=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYY" > .npmrc
133
+ ```
128
134
 
129
135
  #### Using release-it tool
130
136
 
@@ -156,7 +162,6 @@ Generic command, does not automatically add the `beta` to version, but you can s
156
162
 
157
163
  > Do not keep Pull Requests from develop to master branches open when you are doing beta releases from the develop branch. As long as a PR to master is open, an automatic script will run on every commit and will update both the version and the changelog to a production-ready state - ( MAJOR.MINOR.PATCH mandatory format for version).
158
164
 
159
-
160
165
  ## How to contribute
161
166
 
162
167
  See [DEVELOP.md](https://github.com/eea/volto-editing-progress/blob/master/DEVELOP.md).
package/docker-compose.yml ADDED
@@ -0,0 +1,32 @@
1
+ version: "3"
2
+ services:
3
+ backend:
4
+ image: eeacms/plone-backend
5
+ ports:
6
+ - "8080:8080"
7
+ environment:
8
+ SITE: "Plone"
9
+ PROFILES: "eea.kitkat:testing"
10
+
11
+ frontend:
12
+ build:
13
+ context: ./
14
+ dockerfile: ./Dockerfile
15
+ args:
16
+ ADDON_NAME: "${ADDON_NAME}"
17
+ ADDON_PATH: "${ADDON_PATH}"
18
+ VOLTO_VERSION: ${VOLTO_VERSION:-16}
19
+ ports:
20
+ - "3000:3000"
21
+ - "3001:3001"
22
+ depends_on:
23
+ - backend
24
+ volumes:
25
+ - ./:/app/src/addons/${ADDON_PATH}
26
+ environment:
27
+ CI: "true"
28
+ NODE_ENV: "development"
29
+ RAZZLE_JEST_CONFIG: "src/addons/${ADDON_PATH}/jest-addon.config.js"
30
+ RAZZLE_INTERNAL_API_PATH: "http://backend:8080/Plone"
31
+ RAZZLE_DEV_PROXY_API_PATH: "http://backend:8080/Plone"
32
+ HOST: "0.0.0.0"
package/locales/de/LC_MESSAGES/volto.po ADDED
@@ -0,0 +1,17 @@
1
+ msgid ""
2
+ msgstr ""
3
+ "Project-Id-Version: \n"
4
+ "Report-Msgid-Bugs-To: \n"
5
+ "POT-Creation-Date: \n"
6
+ "PO-Revision-Date: \n"
7
+ "Last-Translator: \n"
8
+ "Language: \n"
9
+ "Language-Team: \n"
10
+ "Content-Type: \n"
11
+ "Content-Transfer-Encoding: \n"
12
+ "Plural-Forms: \n"
13
+
14
+ #: TextareaJSONWidget
15
+ # defaultMessage: Please enter valid JSON!
16
+ msgid "Please enter valid JSON!"
17
+ msgstr ""
package/locales/en/LC_MESSAGES/volto.po ADDED
@@ -0,0 +1,17 @@
1
+ msgid ""
2
+ msgstr ""
3
+ "Project-Id-Version: \n"
4
+ "Report-Msgid-Bugs-To: \n"
5
+ "POT-Creation-Date: \n"
6
+ "PO-Revision-Date: \n"
7
+ "Last-Translator: \n"
8
+ "Language: \n"
9
+ "Language-Team: \n"
10
+ "Content-Type: \n"
11
+ "Content-Transfer-Encoding: \n"
12
+ "Plural-Forms: \n"
13
+
14
+ #: TextareaJSONWidget
15
+ # defaultMessage: Please enter valid JSON!
16
+ msgid "Please enter valid JSON!"
17
+ msgstr ""
package/locales/it/LC_MESSAGES/volto.po ADDED
@@ -0,0 +1,17 @@
1
+ msgid ""
2
+ msgstr ""
3
+ "Project-Id-Version: \n"
4
+ "Report-Msgid-Bugs-To: \n"
5
+ "POT-Creation-Date: \n"
6
+ "PO-Revision-Date: \n"
7
+ "Last-Translator: \n"
8
+ "Language: \n"
9
+ "Language-Team: \n"
10
+ "Content-Type: \n"
11
+ "Content-Transfer-Encoding: \n"
12
+ "Plural-Forms: \n"
13
+
14
+ #: TextareaJSONWidget
15
+ # defaultMessage: Please enter valid JSON!
16
+ msgid "Please enter valid JSON!"
17
+ msgstr ""
package/locales/ro/LC_MESSAGES/volto.po ADDED
@@ -0,0 +1,17 @@
1
+ msgid ""
2
+ msgstr ""
3
+ "Project-Id-Version: \n"
4
+ "Report-Msgid-Bugs-To: \n"
5
+ "POT-Creation-Date: \n"
6
+ "PO-Revision-Date: \n"
7
+ "Last-Translator: \n"
8
+ "Language: \n"
9
+ "Language-Team: \n"
10
+ "Content-Type: \n"
11
+ "Content-Transfer-Encoding: \n"
12
+ "Plural-Forms: \n"
13
+
14
+ #: TextareaJSONWidget
15
+ # defaultMessage: Please enter valid JSON!
16
+ msgid "Please enter valid JSON!"
17
+ msgstr ""
package/locales/volto.pot ADDED
@@ -0,0 +1,19 @@
1
+ msgid ""
2
+ msgstr ""
3
+ "Project-Id-Version: Plone\n"
4
+ "POT-Creation-Date: 2023-08-29T17:51:21.719Z\n"
5
+ "Last-Translator: Plone i18n <plone-i18n@lists.sourceforge.net>\n"
6
+ "Language-Team: Plone i18n <plone-i18n@lists.sourceforge.net>\n"
7
+ "MIME-Version: 1.0\n"
8
+ "Content-Type: text/plain; charset=utf-8\n"
9
+ "Content-Transfer-Encoding: 8bit\n"
10
+ "Plural-Forms: nplurals=1; plural=0;\n"
11
+ "Language-Code: en\n"
12
+ "Language-Name: English\n"
13
+ "Preferred-Encodings: utf-8\n"
14
+ "Domain: volto\n"
15
+
16
+ #: TextareaJSONWidget
17
+ # defaultMessage: Please enter valid JSON!
18
+ msgid "Please enter valid JSON!"
19
+ msgstr ""
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@eeacms/volto-editing-progress",
3
- "version": "0.2.2",
3
+ "version": "0.2.3",
4
4
  "description": "@eeacms/volto-editing-progress: Volto add-on",
5
5
  "main": "src/index.js",
6
6
  "author": "European Environment Agency: IDM2 A-Team",
@@ -32,14 +32,18 @@
32
32
  "release-major-beta": "release-it major --preRelease=beta",
33
33
  "release-beta": "release-it --preRelease=beta",
34
34
  "bootstrap": "npm install -g ejs; npm link ejs; node bootstrap",
35
- "stylelint": "../../../node_modules/stylelint/bin/stylelint.js --allow-empty-input 'src/**/*.{css,less}'",
36
- "stylelint:overrides": "../../../node_modules/.bin/stylelint --syntax less --allow-empty-input 'theme/**/*.overrides' 'src/**/*.overrides'",
37
- "stylelint:fix": "yarn stylelint --fix && yarn stylelint:overrides --fix",
38
- "prettier": "../../../node_modules/.bin/prettier --single-quote --check 'src/**/*.{js,jsx,json,css,less,md}'",
39
- "prettier:fix": "../../../node_modules/.bin/prettier --single-quote --write 'src/**/*.{js,jsx,json,css,less,md}'",
40
- "lint": "../../../node_modules/eslint/bin/eslint.js --max-warnings=0 'src/**/*.{js,jsx}'",
41
- "lint:fix": "../../../node_modules/eslint/bin/eslint.js --fix 'src/**/*.{js,jsx}'",
42
- "cypress:run": "../../../node_modules/cypress/bin/cypress run",
43
- "cypress:open": "../../../node_modules/cypress/bin/cypress open"
35
+ "test": "make test",
36
+ "test:fix": "make test-update",
37
+ "pre-commit": "yarn stylelint:fix && yarn prettier:fix && yarn lint:fix",
38
+ "stylelint": "make stylelint",
39
+ "stylelint:overrides": "make stylelint-overrides",
40
+ "stylelint:fix": "make stylelint-fix",
41
+ "prettier": "make prettier",
42
+ "prettier:fix": "make prettier-fix",
43
+ "lint": "make lint",
44
+ "lint:fix": "make lint-fix",
45
+ "i18n": "make i18n",
46
+ "cypress:run": "make cypress-run",
47
+ "cypress:open": "make cypress-open"
44
48
  }
45
49
  }
package/.i18n.babel.config.js DELETED
@@ -1 +0,0 @@
1
- module.exports = require('@plone/volto/babel');