Skip to content

Commit

Permalink
Merge pull request #135 from eea/develop
Browse files Browse the repository at this point in the history
Release
  • Loading branch information
avoinea authored Oct 12, 2023
2 parents 7a04c59 + 6ac7e6f commit 8db263f
Show file tree
Hide file tree
Showing 8 changed files with 251 additions and 129 deletions.
87 changes: 63 additions & 24 deletions CHANGELOG.md

Large diffs are not rendered by default.

19 changes: 8 additions & 11 deletions DEVELOP.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# volto-eea-kitkat

[Volto](https://github.com/plone/volto) Add-ons bundle - A known good set of Volto addons to be used within all EEA projects and beyond

## Develop

1. Make sure you have `docker` and `docker compose` installed and running on your machine:
Expand All @@ -18,12 +16,14 @@

1. Go to http://localhost:3000

1. Happy hacking!
1. Initialize git hooks

```Bash
cd src/addons/volto-eea-kitkat/
yarn prepare
```

1. Happy hacking!

### Or add @eeacms/volto-eea-kitkat 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/)
Expand All @@ -34,8 +34,8 @@ Before starting make sure your development environment is properly set. See [Vol

1. Create new volto app

yo @plone/volto kitkat-volto-project --addon @eeacms/volto-eea-kitkat --skip-install
cd kitkat-volto-project
yo @plone/volto my-volto-project --addon @eeacms/volto-eea-kitkat --skip-install
cd my-volto-project

1. Add the following to `mrs.developer.json`:

Expand All @@ -50,18 +50,15 @@ Before starting make sure your development environment is properly set. See [Vol

1. Install

yarn develop
make develop
yarn

1. Start backend

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

1. Start frontend
Expand Down
2 changes: 1 addition & 1 deletion Jenkinsfile
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ pipeline {
NAMESPACE = "@eeacms"
SONARQUBE_TAGS = "volto.eea.europa.eu,climate-energy.eea.europa.eu,forest.eea.europa.eu,biodiversity.europa.eu,www.eea.europa.eu-ims,sustainability.eionet.europa.eu,clms.land.copernicus.eu,industry.eea.europa.eu,water.europa.eu-freshwater,demo-www.eea.europa.eu,clmsdemo.devel6cph.eea.europa.eu,water.europa.eu-marine,climate-adapt.eea.europa.eu,climate-advisory-board.devel4cph.eea.europa.eu,climate-advisory-board.europa.eu,www.eea.europa.eu-en"
DEPENDENCIES = ""
VOLTO = ""
VOLTO = "16"
}

stages {
Expand Down
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
94 changes: 90 additions & 4 deletions README.md

Large diffs are not rendered by default.

28 changes: 14 additions & 14 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,55 +20,55 @@ 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`)
2. `CHANGELOG.md` automatic generation from commit messages ( grouped by releases )
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).
4 changes: 2 additions & 2 deletions cypress.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ const { defineConfig } = require('cypress');

module.exports = defineConfig({
viewportWidth: 1280,
defaultCommandTimeout: 5000,
defaultCommandTimeout: 8888,
chromeWebSecurity: false,
reporter: 'junit',
video: true,
retries: {
runMode: 1,
runMode: 8,
openMode: 0,
},
reporterOptions: {
Expand Down
142 changes: 71 additions & 71 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@eeacms/volto-eea-kitkat",
"version": "18.1.3",
"version": "18.2.0",
"description": "@eeacms/volto-eea-kitkat: Volto Add-ons bundle - A known good set of Volto addons to be used within all EEA projects and beyond",
"main": "src/index.js",
"author": "European Environment Agency: IDM2 A-Team",
Expand Down Expand Up @@ -59,81 +59,81 @@
"@eeacms/volto-anchors"
],
"dependencies": {
"@eeacms/countup": "2.0.4",
"@eeacms/volto-accordion-block": "10.3.0",
"@eeacms/volto-anchors": "0.4.1",
"@eeacms/volto-banner": "3.1.3",
"@eeacms/volto-block-divider": "6.1.2",
"@eeacms/volto-block-image-cards": "1.3.3",
"@eeacms/volto-block-style": "5.2.3",
"@eeacms/volto-call-to-action-block": "4.1.4",
"@eeacms/volto-columns-block": "6.3.3",
"@eeacms/volto-corsproxy": "3.1.3",
"@eeacms/volto-description-block": "1.1.3",
"@eeacms/volto-group-block": "6.3.1",
"@eeacms/volto-hero-block": "5.4.1",
"@eeacms/volto-listing-block": "5.0.1",
"@eeacms/volto-matomo": "4.1.3",
"@eeacms/volto-metadata-block": "6.0.0",
"@eeacms/volto-nextcloud-video-block": "0.4.4",
"@eeacms/volto-object-widget": "5.1.3",
"@eeacms/volto-quote-block": "1.2.2",
"@eeacms/volto-resize-helper": "1.3.3",
"@eeacms/volto-sentry-rancher-config": "3.1.1",
"@eeacms/volto-slate-footnote": "6.1.5",
"@eeacms/volto-slate-label": "0.5.5",
"@eeacms/volto-slate-metadata-mentions": "7.0.0",
"@eeacms/volto-slate-zotero": "5.2.3",
"@eeacms/volto-statistic-block": "3.0.1",
"@eeacms/volto-tabs-block": "5.1.0",
"@eeacms/volto-tags-block": "1.2.1",
"@eeacms/volto-taxonomy": "4.1.0",
"@eeacms/volto-timeline-block": "1.1.2",
"@eeacms/volto-widget-dataprovenance": "0.4.0",
"@eeacms/volto-widget-geolocation": "5.1.3",
"@eeacms/volto-widget-temporal-coverage": "5.1.3",
"@eeacms/volto-widget-theme-picker": "1.1.3",
"@eeacms/volto-widget-toggle": "3.1.2",
"@eeacms/countup": "2.0.6",
"@eeacms/volto-accordion-block": "10.4.1",
"@eeacms/volto-anchors": "0.4.2",
"@eeacms/volto-banner": "3.1.4",
"@eeacms/volto-block-divider": "6.1.3",
"@eeacms/volto-block-image-cards": "1.3.4",
"@eeacms/volto-block-style": "5.2.4",
"@eeacms/volto-call-to-action-block": "4.2.1",
"@eeacms/volto-columns-block": "6.3.4",
"@eeacms/volto-corsproxy": "3.1.4",
"@eeacms/volto-description-block": "1.2.1",
"@eeacms/volto-group-block": "6.3.2",
"@eeacms/volto-hero-block": "5.4.2",
"@eeacms/volto-listing-block": "6.0.0",
"@eeacms/volto-matomo": "4.2.1",
"@eeacms/volto-metadata-block": "6.0.1",
"@eeacms/volto-nextcloud-video-block": "0.4.6",
"@eeacms/volto-object-widget": "5.1.4",
"@eeacms/volto-quote-block": "1.2.3",
"@eeacms/volto-resize-helper": "1.3.4",
"@eeacms/volto-sentry-rancher-config": "3.1.2",
"@eeacms/volto-slate-footnote": "6.1.6",
"@eeacms/volto-slate-label": "0.5.6",
"@eeacms/volto-slate-metadata-mentions": "7.0.1",
"@eeacms/volto-slate-zotero": "5.2.4",
"@eeacms/volto-statistic-block": "4.0.2",
"@eeacms/volto-tabs-block": "6.0.1",
"@eeacms/volto-tags-block": "1.2.2",
"@eeacms/volto-taxonomy": "4.1.1",
"@eeacms/volto-timeline-block": "1.1.3",
"@eeacms/volto-widget-dataprovenance": "0.4.1",
"@eeacms/volto-widget-geolocation": "5.1.4",
"@eeacms/volto-widget-temporal-coverage": "5.1.4",
"@eeacms/volto-widget-theme-picker": "1.1.4",
"@eeacms/volto-widget-toggle": "3.1.3",
"@kitconcept/volto-blocks-grid": "7.0.2",
"@plone-collective/volto-sentry": "0.3.0"
},
"resolutions": {
"@eeacms/volto-nextcloud-video-block": "0.4.4",
"@eeacms/volto-anchors": "0.4.1",
"@eeacms/volto-quote-block": "1.2.2",
"@eeacms/volto-statistic-block": "3.0.1",
"@eeacms/volto-tags-block": "1.2.1",
"@eeacms/volto-call-to-action-block": "4.1.4",
"@eeacms/volto-hero-block": "5.4.1",
"@eeacms/volto-timeline-block": "1.1.2",
"@eeacms/volto-description-block": "1.1.3",
"@eeacms/volto-slate-label": "0.5.5",
"@eeacms/volto-nextcloud-video-block": "0.4.6",
"@eeacms/volto-anchors": "0.4.2",
"@eeacms/volto-quote-block": "1.2.3",
"@eeacms/volto-statistic-block": "4.0.2",
"@eeacms/volto-tags-block": "1.2.2",
"@eeacms/volto-call-to-action-block": "4.2.1",
"@eeacms/volto-hero-block": "5.4.2",
"@eeacms/volto-timeline-block": "1.1.3",
"@eeacms/volto-description-block": "1.2.1",
"@eeacms/volto-slate-label": "0.5.6",
"@plone-collective/volto-sentry": "0.3.0",
"@eeacms/volto-accordion-block": "10.3.0",
"@eeacms/volto-banner": "3.1.3",
"@eeacms/volto-block-divider": "6.1.2",
"@eeacms/volto-block-image-cards": "1.3.3",
"@eeacms/volto-block-style": "5.2.3",
"@eeacms/volto-columns-block": "6.3.3",
"@eeacms/volto-corsproxy": "3.1.3",
"@eeacms/volto-group-block": "6.3.1",
"@eeacms/volto-listing-block": "5.0.1",
"@eeacms/volto-matomo": "4.1.3",
"@eeacms/volto-metadata-block": "6.0.0",
"@eeacms/volto-object-widget": "5.1.3",
"@eeacms/volto-resize-helper": "1.3.3",
"@eeacms/volto-sentry-rancher-config": "3.1.1",
"@eeacms/volto-slate-footnote": "6.1.5",
"@eeacms/volto-slate-metadata-mentions": "7.0.0",
"@eeacms/volto-slate-zotero": "5.2.3",
"@eeacms/volto-tabs-block": "5.1.0",
"@eeacms/volto-taxonomy": "4.1.0",
"@eeacms/volto-widget-geolocation": "5.1.3",
"@eeacms/volto-widget-dataprovenance": "0.4.0",
"@eeacms/volto-widget-temporal-coverage": "5.1.3",
"@eeacms/volto-widget-toggle": "3.1.2",
"@eeacms/volto-widget-theme-picker": "1.1.3",
"@eeacms/countup": "2.0.4"
"@eeacms/volto-accordion-block": "10.4.1",
"@eeacms/volto-banner": "3.1.4",
"@eeacms/volto-block-divider": "6.1.3",
"@eeacms/volto-block-image-cards": "1.3.4",
"@eeacms/volto-block-style": "5.2.4",
"@eeacms/volto-columns-block": "6.3.4",
"@eeacms/volto-corsproxy": "3.1.4",
"@eeacms/volto-group-block": "6.3.2",
"@eeacms/volto-listing-block": "6.0.0",
"@eeacms/volto-matomo": "4.2.1",
"@eeacms/volto-metadata-block": "6.0.1",
"@eeacms/volto-object-widget": "5.1.4",
"@eeacms/volto-resize-helper": "1.3.4",
"@eeacms/volto-sentry-rancher-config": "3.1.2",
"@eeacms/volto-slate-footnote": "6.1.6",
"@eeacms/volto-slate-metadata-mentions": "7.0.1",
"@eeacms/volto-slate-zotero": "5.2.4",
"@eeacms/volto-tabs-block": "6.0.1",
"@eeacms/volto-taxonomy": "4.1.1",
"@eeacms/volto-widget-geolocation": "5.1.4",
"@eeacms/volto-widget-dataprovenance": "0.4.1",
"@eeacms/volto-widget-temporal-coverage": "5.1.4",
"@eeacms/volto-widget-toggle": "3.1.3",
"@eeacms/volto-widget-theme-picker": "1.1.4",
"@eeacms/countup": "2.0.6"
},
"devDependencies": {
"@cypress/code-coverage": "^3.10.0",
Expand Down

0 comments on commit 8db263f

Please sign in to comment.