Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 2.81 KB

RELEASE.md

File metadata and controls

71 lines (51 loc) · 2.81 KB
Raw

Release management and procedure

Since GeoNetwork UI is based on a monorepo architecture, all its components (applications, libraries) share the same version number.

Version

Project version is structured like so: <major>.<minor>.<patch>

Whenever a release is made, the version number is increased according to the following rules:

  • Major version is incremented when:
    • a breaking change is introduced in one of the following systems
      • Configuration files
      • Docker images usage
    • a backend requirement change that is not backwards compatible (e.g. GeoNetwork version)
    • a significant architecture change happened
  • Minor version is incremented when:
    • one or several features were added to the applications
    • a framework upgrade was done (i.e. Angular or Nx)
    • a backend requirement change that is backwards compatible (e.g. GeoNetwork version)
  • Patch version is incremented for any other kind of change: bug fixes, compatibility fixes, typos, minor tweaks...

How to upgrade the version

Use the following commands to upgrade to a stable (non development) version:

npm version 1.3.6 --no-git-tag-version
git add .
git commit -m "1.3.6"
git tag v1.3.6
git push upstream main v1.3.6 # replace "upstream" with your remote repo name

This will update all package.json files in the repository, create a commit changing the version and an associated tag, and push both to the remote repository.

Once the version commit and tag are done and pushed, run the following commands to upgrade to an intermediary dev version:

npm version 1.4.0-dev --no-git-tag-version # dev versions are a minor version above stable ones
git add .
git commit -m "1.4.0-dev"
git push upstream main

Note that we're not tagging dev versions.

Releases

When and what to release

Releases are made periodically when needed. Each release includes:

  • An archive of each application, named like so: geonetwork-ui-{application-name}-{version}.zip
    Example: geonetwork-ui-datahub-1.2.5.zip
  • A docker image of each application, tagged like so: geonetwork/geonetwork-ui-{application-name}:{version} Example: geonetwork/geonetwork-ui-datahub:1.2.5

Note that the latest development version of each application is also available by replacing the version with the branch name, for example: geonetwork-ui-datahub-main.zip or geonetwork/geonetwork-ui-datahub:main

How to make a release

When a release is created in GitHub, the CI automatically generates the associated artifacts which are then either attached to the release (archives) or pushed to Dockerhub (docker images).

To trigger this, simply push a git tag and then create a release from it as described here: https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release