Release 2024.01.00

[tdipisa]

Setup and preliminary checks

This steps have to be followed always when preparing a new release.

• Create an issue with this checklist in the release milestone, named "Release YYYY.XX.mm".
• Create the milestone if it doesn't exist. (Name YYYY.XX.mm).
• Verify if it is needed to release a new version of http_proxy, mapfish-print or geostore, and do it if necessary accordingly with release calendar 2022.
  • for geostore, check if here is present the version specified. Release procedure is specified in the Readme.md file of the project.
  • for http_proxy, check if here is present the version specified. Release procedure is specified in the Readme.md file of the project.
    - [ ] for mapfish-print check if here is present the version specified. Release procedure is specified in the Readme.md file of the project. (official or geosolutions mapfish-print-v2 must be used for thsi release)

New stable branch creation

Only if you need to create a new stable major release (YYYY.XX.00), you need to create a branch for it. Check the following:

• Run the Cut Release Branch workflow on github.
  With the following Parameters:

  • Use workflow from branch master
  • MapStore branch name to use: YYYY.XX.xx
  • Version of MapFish Print, GeoStore and HTTP-Proxy accordingly to the MapStore release calendar
  • use the default value for the other parameters

• Wait for the process to complete. At the end:

  • A Pull request will be created to the master
  • A new branch named YYYY.XX.xx with fixed versions

• Merge the incoming PR created by the workflow

• Create on ReadTheDocs project the version build for YYYY.XX.xx (click on "Versions" and activate the version of the branch)

• Run the Cut Release Branch workflow on MapStoreExtension project, indicating:

  • Use workflow from branch master
  • MapStore branch name to use: YYYY.XX.xx
  • main branch master (default)

• Update the QA build to point to the branch created (YYYY.XX.xx)

Before the Release

• Check pom.xml dependencies are all in fixed stable versions ( no -SNAPSHOT usage release). If not, You use the action Update dependencies versions to fix them, setting:
• Check that MapStoreExtension repository is aligned and working
• Test on QA https://qa-mapstore.geosolutionsgroup.com/mapstore/
  • Test everything, not only the new features
  • Test the creation of a standard project starting in from the stable branch and with the internal backend, so:
    • node ./createProject.js and insert the entries (for the rest simply press enter:
      • project name: release_project_test
      • base branch: insert the release branch (e.g. YYYY.XX.xx)
      • project folder insert ../test_release_<release_number> )
    • cd ../test_release_<release_number>
    • npm install
    • npm run start:app, then check that an empty homepage loads correctly
  • Test Binary (take the mapstore2-<RELEASE_BRANCH>-qa-bin.zip, from latest build)

Prepare Release

• Run Prepare Release workflow on github actions with the following parameters:
  • Use workflow from branch YYYY.XX.xx (the release branch)
  • Version to release YYYY.XX.mm (the effective number of the release)
  • MapStore version for changelog generation YYYY.XX.mm (the effective number of the previous release)
  • version to fix for the java module, accordingly with release schedule (e.g. 1.7.0)
  • use the default value for the other parameters
• Wait for the process to complete. At the end:
  • a new commit will be added to the release branch tagged as vYYYY.XX.mm. This commit will contain the changelog and the updated version of the java modules.
  • a pull request will be created on master with the changelog updates
• Merge the incoming PR created by the workflow for updating changelog on Master

MapStore Stable deploy

• check if there are changes to be ported to STABLE branch of mapstore-datadir repo
  • if so prepare a PR to be merged
  • merge the PR and move on with the steps otherwise stop here
• Launch the MapStore2-Stable-Build and wait for the MapStore2-Stable-EndPointsTests to complete as well
  • When previous two jobs are green you can:
    • Lunch MapStore2-Stable-Build
      • branch build on stable branch YYYY.XX.xx
      • version: YYYY.XX.mm
    • After "MapStore2-Stable-Build" finished, Launch MapStore2-Stable-Deploy to install the latest stable version on official demo
    • test the change has been applied, login on https://mapstore.geosolutionsgroup.com and verify that the layers from gs-stable are visible without errors (typically authentication errors that was caused by the wrong auth-key).

Build and publishing release

• Run Create Release workflow on github actions with the following parameters:
  • Use workflow from branch YYYY.XX.xx (the release branch)
  • Version to release YYYY.XX.mm (the effective number of the release)
• Launch MapStore2-Stable-Releaser Jenkins job with
  • YYYY.XX.mm for the version
  • YYYY.XX.xx for the branch to build
• Wait the end of the 2 process

When the processes are finished, the release is ready to be published on github in draft mode.

• Open the new release in draft from here
• Update the link to Docker in the release notes with the link to the latest stable release (search the new tag on docker hub )
• Update the description of the release details
• Publish the release
• create on ReadTheDocs project the version build for vYYYY.XX.mm (click on "Versions" and activate the version of the tag, created when release was published)
• Update Default version to point the release version in the Advanced Settings menu of the ReadTheDocs admin panel

Build and publish MapStoreExtension release

• Create a draft release for MapstoreExtension with the same name and tag
  • target of the release is stable branch aligned to latest commit in stable branch of main mapstore repo
  • tag is vYYYY.XX.mm
  • Update revision of mapstore to the release tag vYYYY.XX.mm
  • run the build locally and attach to the release the file SampleExtension.zip from the /dist folder
  • create a PR for the changes of the revision to the MapstoreExtension repo
  • Merge the PR
  • Publish the release
  • Link the MapStore extension release in the MapStore release

Finalize Release

• Run the Post Release workflow on github with the following parameters:
  • Use workflow from branch YYYY.XX.xx (the release branch)
  • Version of Java Packages to restore accordingly with release calendar with -SNAPSHOT E.g. 1.7-SNAPSHOT
• Write to the mailing list about the current release news and the next release major changes
• Optional - prepare a PR for updating release procedure, if needed
• Close this issue
• Close the related milestone YYYY.XX.mm

Other useful information

[ElenaGallo]

@tdipisa all functional tests passed (here the test run). I also did the Binary test, the new MapStoreExtension test and the creation of a standard project.
From me side we can proceed with the release tomorrow

[tdipisa]

Release notes available here:
https://github.com/geosolutions-it/MapStore2/releases/tag/v2024.01.00