diff --git a/CHANGELOG.md b/CHANGELOG.md index 6b857c8..70f80d0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,20 @@ All notable changes to this project will be documented in this file. Dates are d Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog). +### [4.0.2](https://github.com/eea/volto-statistic-block/compare/4.0.1...4.0.2) - 12 October 2023 + +#### :house: Internal changes + +- chore:volto 16 in tests, update docs, fix stylelint overrides [valentinab25 - [`3558e1b`](https://github.com/eea/volto-statistic-block/commit/3558e1bfb0abb8177ab0ea0b97ceebe000b21917)] + +#### :house: Documentation changes + +- docs: Update README and DEVELOP [Alin Voinea - [`893f054`](https://github.com/eea/volto-statistic-block/commit/893f0549902ff08c58c48c19ad9ff979ab77ffab)] + +#### :hammer_and_wrench: Others + +- test: change volto version in Jenkinsfile [ana-oprea - [`bb20e32`](https://github.com/eea/volto-statistic-block/commit/bb20e323b82cded55030193540517633a8716597)] +- test: Re-enable SonarQube coverage check [Alin Voinea - [`7da5560`](https://github.com/eea/volto-statistic-block/commit/7da5560cd4784b428395bd02b63a8aa763f29819)] ### [4.0.1](https://github.com/eea/volto-statistic-block/compare/4.0.0...4.0.1) - 28 September 2023 #### :house: Documentation changes diff --git a/Jenkinsfile b/Jenkinsfile index f775ba3..98e3986 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -6,7 +6,7 @@ pipeline { NAMESPACE = "@eeacms" SONARQUBE_TAGS = "volto.eea.europa.eu,demo-www.eea.europa.eu,forest.eea.europa.eu,clmsdemo.devel6cph.eea.europa.eu,water.europa.eu-marine,biodiversity.europa.eu,climate-adapt.eea.europa.eu,climate-energy.eea.europa.eu,climate-advisory-board.devel4cph.eea.europa.eu,climate-advisory-board.europa.eu,www.eea.europa.eu-ims,www.eea.europa.eu-en,industry.eea.europa.eu,water.europa.eu-freshwater" DEPENDENCIES = "" - VOLTO = "" + VOLTO = "16" } stages { @@ -215,36 +215,36 @@ pipeline { } } - // stage('SonarQube compare to master') { - // when { - // anyOf { - // allOf { - // not { environment name: 'CHANGE_ID', value: '' } - // environment name: 'CHANGE_TARGET', value: 'develop' - // } - // allOf { - // environment name: 'CHANGE_ID', value: '' - // branch 'develop' - // not { changelog '.*^Automated release [0-9\\.]+$' } - // } - // } - // } - // steps { - // node(label: 'docker') { - // script { - // sh '''docker pull eeacms/gitflow''' - // sh '''echo "Error" > checkresult.txt''' - // catchError(buildResult: 'FAILURE', stageResult: 'FAILURE') { - // sh '''set -o pipefail; docker run -i --rm --name="$BUILD_TAG-gitflow-sn" -e GIT_BRANCH="$BRANCH_NAME" -e GIT_NAME="$GIT_NAME" eeacms/gitflow /checkSonarqubemaster.sh | grep -v "Found script" | tee checkresult.txt''' - // } + stage('SonarQube compare to master') { + when { + anyOf { + allOf { + not { environment name: 'CHANGE_ID', value: '' } + environment name: 'CHANGE_TARGET', value: 'develop' + } + allOf { + environment name: 'CHANGE_ID', value: '' + branch 'develop' + not { changelog '.*^Automated release [0-9\\.]+$' } + } + } + } + steps { + node(label: 'docker') { + script { + sh '''docker pull eeacms/gitflow''' + sh '''echo "Error" > checkresult.txt''' + catchError(buildResult: 'FAILURE', stageResult: 'FAILURE') { + sh '''set -o pipefail; docker run -i --rm --name="$BUILD_TAG-gitflow-sn" -e GIT_BRANCH="$BRANCH_NAME" -e GIT_NAME="$GIT_NAME" eeacms/gitflow /checkSonarqubemaster.sh | grep -v "Found script" | tee checkresult.txt''' + } - // publishChecks name: 'SonarQube', title: 'Sonarqube Code Quality Check', summary: "Quality check on the SonarQube metrics from branch develop, comparing it with the ones from master branch. No bugs are allowed", - // text: readFile(file: 'checkresult.txt'), conclusion: "${currentBuild.currentResult}", - // detailsURL: "${env.BUILD_URL}display/redirect" - // } - // } - // } - // } + publishChecks name: 'SonarQube', title: 'Sonarqube Code Quality Check', summary: "Quality check on the SonarQube metrics from branch develop, comparing it with the ones from master branch. No bugs are allowed", + text: readFile(file: 'checkresult.txt'), conclusion: "${currentBuild.currentResult}", + detailsURL: "${env.BUILD_URL}display/redirect" + } + } + } + } stage('Pull Request') { when { diff --git a/Makefile b/Makefile index 4a5cbed..f3614a8 100644 --- a/Makefile +++ b/Makefile @@ -97,12 +97,12 @@ stylelint: ## Stylelint .PHONY: stylelint-overrides stylelint-overrides: - $(NODE_MODULES)/.bin/stylelint --syntax less --allow-empty-input 'theme/**/*.overrides' 'src/**/*.overrides' + $(NODE_MODULES)/.bin/stylelint --custom-syntax less --allow-empty-input 'theme/**/*.overrides' 'src/**/*.overrides' .PHONY: stylelint-fix stylelint-fix: ## Fix stylelint $(NODE_MODULES)/stylelint/bin/stylelint.js --allow-empty-input 'src/**/*.{css,less}' --fix - $(NODE_MODULES)/.bin/stylelint --syntax less --allow-empty-input 'theme/**/*.overrides' 'src/**/*.overrides' --fix + $(NODE_MODULES)/.bin/stylelint --custom-syntax less --allow-empty-input 'theme/**/*.overrides' 'src/**/*.overrides' --fix .PHONY: prettier prettier: ## Prettier diff --git a/README.md b/README.md index e61ddc1..2b8eed0 100644 --- a/README.md +++ b/README.md @@ -50,25 +50,25 @@ Go to http://localhost:3000 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-statistic-block" - ], + ```JSON + "addons": [ + "@eeacms/volto-statistic-block" + ], - "dependencies": { - "@eeacms/volto-statistic-block": "*" - } - ``` + "dependencies": { + "@eeacms/volto-statistic-block": "*" + } + ``` -- If not, create one: +* If not, create one: - ``` - npm install -g yo @plone/generator-volto - yo @plone/volto my-volto-project --addon @eeacms/volto-statistic-block - cd my-volto-project - ``` + ``` + npm install -g yo @plone/generator-volto + yo @plone/volto my-volto-project --canary --addon @eeacms/volto-statistic-block + cd my-volto-project + ``` 1. Install new add-ons and restart Volto: diff --git a/RELEASE.md b/RELEASE.md index 24f98ee..4e311a0 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -20,9 +20,9 @@ You need to first install the [release-it](https://github.com/release-it/release ``` npm install -g release-it ``` - + Release-it uses the configuration written in the [`.release-it.json`](./.release-it.json) file located in the root of the repository. - + Release-it is a tool that automates 4 important steps in the release process: 1. Version increase in `package.json` ( increased from the current version in `package.json`) @@ -30,45 +30,45 @@ Release-it is a tool that automates 4 important steps in the release process: 3. GitHub release on the commit with the changelog and package.json modification on the develop branch 4. NPM release ( by default it's disabled, but can be enabled in the configuration file ) -To configure the authentification, you need to export GITHUB_TOKEN for [GitHub](https://github.com/settings/tokens) +To configure the authentification, you need to export GITHUB_TOKEN for [GitHub](https://github.com/settings/tokens) ``` export GITHUB_TOKEN=XXX-XXXXXXXXXXXXXXXXXXXXXX ``` - + To configure npm, you can use the `npm login` command or use a configuration file with a TOKEN : - + ``` echo "//registry.npmjs.org/:_authToken=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYY" > .npmrc ``` #### Using release-it tool - + There are 3 yarn scripts that can be run to do the release ##### yarn release-beta -Automatically calculates and presents 3 beta versions - patch, minor and major for you to choose ( or Other for manual input). +Automatically calculates and presents 3 beta versions - patch, minor and major for you to choose ( or Other for manual input). ``` -? Select increment (next version): -❯ prepatch (0.1.1-beta.0) - preminor (0.2.0-beta.0) - premajor (1.0.0-beta.0) - Other, please specify... +? Select increment (next version): +❯ prepatch (0.1.1-beta.0) + preminor (0.2.0-beta.0) + premajor (1.0.0-beta.0) + Other, please specify... ``` ##### yarn release-major-beta Same as `yarn release-beta`, but with premajor version pre-selected. - + ##### yarn release Generic command, does not automatically add the `beta` to version, but you can still manually write it if you choose Other. #### Important notes -> Do not use release-it tool on master branch, the commit on CHANGELOG.md file and the version increase in the package.json file can't be done without a PULL REQUEST. +> Do not use release-it tool on master branch, the commit on CHANGELOG.md file and the version increase in the package.json file can't be done without a PULL REQUEST. > 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). diff --git a/package.json b/package.json index a614550..88fdd17 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@eeacms/volto-statistic-block", - "version": "4.0.1", + "version": "4.0.2", "description": "@eeacms/volto-statistic-block: Volto add-on", "main": "src/index.js", "author": "European Environment Agency: IDM2 A-Team",