@eeacms/volto-banner

volto-banner

Volto add-on

Features

A customizable banner to highlight to the user that the website is in demo, dev or staging state.

It is configurable through /controlpanel/banner.

Upgrades

Upgrade to 2.x.x

• Version 2.x.x requires eea.banner Plone add-on to be installed on backend.

Getting started

Start Plone backend with Docker

1. Get the latest Docker images

   docker pull plone
   docker pull plone/volto
   

2. Start Plone backend

   docker run -it --rm -p 8080:8080 -e SITE=Plone -e ADDONS="eea.banner" -e PROFILES="profile-eea.banner:default" plone
   

3. 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:

  "addons": [
      "@eeacms/volto-banner"
  ],
  
  "dependencies": {
      "@eeacms/volto-banner": "^2.0.0"
  }
  

• 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
  

1. Install new add-ons and start Volto:

   yarn
   yarn start
   

2. Go to http://localhost:3000

3. Login admin:admin

4. Go to Site Setup > Banner settings and configure your banner

Release

Automatic release using Jenkins

• The automatic release is started by creating a Pull Request 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.
• It runs on every commit on master branch, which is protected from direct commits, only allowing pull request merge commits.
• The automatic release is done by Jenkins. 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.
• Automated release scripts are located in the eeacms/gitflow docker image, specifically js-release.sh script. It uses the release-it tool.
• 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.
• The version format must be MAJOR.MINOR.PATCH. By default, next release is set to next minor version (with patch 0).
• 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.
• Automated commits and commits with [JENKINS] or [YARN] in the commit log are excluded from CHANGELOG.md file.

Manual release from the develop branch ( beta release )

Installation and configuration of release-it

You need to first install the release-it client.

npm install -g release-it

Release-it uses the configuration written in the .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

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).

? 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 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).

How to contribute

See DEVELOP.md.

Copyright and license

The Initial Owner of the Original Code is European Environment Agency (EEA). All Rights Reserved.

See LICENSE.md for details.

Funding

European Environment Agency (EU)

Changelog

2.0.0 - 16 February 2022

:hammer_and_wrench: Others

• Upgrade to 2.x.x [Alin Voinea - 2522d5e]
• Update docs [Alin Voinea - 9b862c6]
• Add more states [Alin Voinea - 1a6d246]
• Updated README [Miu Razvan - 572b4d7]
• Improvments [Miu Razvan - 8a8b9a9]
• Show banner only if data from @banner is loaded [Miu Razvan - 9b3058c]
• Breaking change. Bump version to 2.0.0 [Alin Voinea - fbb32d4]