Home

Awesome

Industry: Volto frontend

Release Pipeline Pipeline Release pipeline

Documentation

A training on how to create your own website using Volto is available as part of the Plone training at https://training.plone.org/5/volto/index.html.

Getting started

  1. Install nvm

     touch ~/.bash_profile
 curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.34.0/install.sh | bash

 source ~/.bash_profile
 nvm version

  2. Install latest NodeJS 12.x:

     nvm install 12
 nvm use 12
 node -v
 v12.16.2

  3. Install yarn

     curl -o- -L https://yarnpkg.com/install.sh | bash
 yarn -v

  4. Clone:

     git clone https://github.com/eea/industry-frontend.git
 cd industry-frontend

  5. Install

     yarn build

  6. Start backend

     docker-compose up -d
 docker-compose logs -f backend

  7. Start frontend

     yarn start:prod

  8. See application at http://localhost:3000

Try it

  1. Install Docker

  2. Install Docker Compose

  3. Start:

     git clone https://github.com/eea/industry-frontend.git
 cd industry-frontend

 docker-compose pull
 docker-compose up -d

    optionally change PORTS via .env:

     FRONTEND=9000 BACKEND=9100 docker-compose up -d

  4. See application at http://localhost:4000

Automated @eeacms dependencies upgrades

All the addon dependencies that are located in the dependencies section of package.json file that belong to @eeacms and have a MAJOR.MINOR.PATCH version are automatedly upgraded on the release of a new version of the addon. This upgrade is done directly on the develop branch.

Exceptions from automated upgrades ( see https://docs.npmjs.com/cli/v8/configuring-npm/package-json#dependencies for dependency configuration examples ) :

Release

Automatic release using Jenkins

Release flow

The release flow on Volto projects is split in 2 Jenkins jobs:

How to start a Production release

The release job that runs on the master branch only creates the release in GitHub. The release job that runs on the new tag is the one that does the rest.

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

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

The release can be triggered by creating a new tag in the GitHub repository. It is not recommended to do this, because both the version from package.json and the CHANGELOG.md files will be desynchronized.

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

Production

We use Docker, Rancher and Jenkins to deploy this application in production.

Release

Upgrade