TerriaJS v7 to v8 - Jul 21 Release

[AnaBelgun]

By v8 release we understand taking the steps to switch current "master" https://github.com/TerriaJS/terriajs/tree/master to the "next" branch https://github.com/TerriaJS/terriajs/tree/next. Focus on critical / breaking changes, guides and communication to community.

3 streams / Objectives:

1) Critical migrations/breaking changes

Error handling - #3486

• Error handling ROUND 2 - ding ding ding #5454 - high
• Update (some) error messages  #5459 - high
• Improve MagdaCatalogItem error messages #4898
• UX: Review errors raised to users - what user problems do we want to solve in writing a better error handling system #5416

Deprecations

• Deprecations for TerriaJS v8.0.0 #4212 - high

Other

• Use translation prefix with translate# #5611 - high
• Enable choosing of basemaps that are available #5382 - high
• translation keys prefix TerriaMap#534

2) Consistency - Model Layer architecture and consistency

• Migration v7 - v8 - reinstate allow load for WMS group  #5641 - high
• TerriaJS v7-v8: MapboxMapCatalogueItem support #5599
• Terria v7 - v8: MapboxStyleCatalogItem support and MapboxMapCatalogueItem support #5600 - high
• TerriaJS v7 - v8: Socrata support #5492 - high
• Model architecture: Add support for continuous color ramps #3441 - high

3) Community - High priority

Documentation, guides, warnings etc.

• Deprecations for TerriaJS v8.0.0 #4212 - high
• Write documentation on how and when to use AsyncLoader #5031 - high
• Migration v7-v8 - Documentation - catalogue items - traits #5637 - high
• Fix init docs formatting #5351 - high
• Migration v7 - v8 - Base maps handling docs #5639 - high
• Migration v7 - v8 - Update warnings #5645 - high
• Mobx migration guide #4688 - high
• https://github.com/TerriaJS/product/issues/28 - high
• v7 - v8 migration: documentation "getting started"  #5667 - high
• v7 - v8 URL migration: documentation v7 and v8  #5668 - high
• Migration v7 - v8 - Documentation - Nested tables #5638 - high
• v7 - v8: Gitter to be decommissioned  #5669 - high
• v7 - v8 - Publish blog and message in GitHub Discussions #5670 - high

Catalogue converter

• Investigate missing warnings and errors for nested configuration catalog-converter#3 - high
• Make the cli script runnable with npx catalog-converter#44 - high
• Go through v7 maps, run catalog-converter and aggregate errors #5467

TerriaMap (fork) on v8

• TerriaMap - release on v8/next TerriaMap#536 - high

Planning included:

• https://github.com/terriajs/product/issues/63 - Closed
• https://github.com/TerriaJS/terriajs/issues?q=is%3Aopen+is%3Aissue+label%3AV8-release+label%3Av8-model-layer-consistency
• https://github.com/TerriaJS/terriajs/issues?q=is%3Aopen+is%3Aissue+label%3AV8-release

[AnaBelgun]

Post launch tasks - to be refined and re-prioritised based on user feedback #5677

[AnaBelgun]

v8 draft launch checklist:

On 9th of August, at 1:00pm AEST start:

• rename next branch = main and set as default branch
• rename master branch = v7.x.x
• npm publish - remove alpha tag and start 8.0.0 tag
• modify CI script, github actions with new branch name
• swap terria map (used for forks) to v8.0.0
• npm release - attention to configuration
• ReadME in TerriaJS (both main and v7.x.x) and Terria map (fork) - updated version of TerriaJS
• ReadME - link to documentation https://docs-v8.terria.io/guide/
• helm chart terria map - attention to Bing key - include a link to Bing geocoder free key for developers and provide instruction in getting started on how to configure the key
• merge master TerriaMap#538

[tephenavies]

V8 release checklist

• Merge Error handling ROUND 2 - ding ding ding #5454
• Skip error service initialization when no config provided. #5717
• Organize models #5626
• migration guide 2 #5712
• Add catalog-converter bin and update README. catalog-converter#47
• Add more PRs to the list here
• PR & merge migration guide
• Link to v7 docs from v8 docs

terriajs rollout:

• PR to master: modify GH actions to branchname v7.x.x, update README, change npm publish bot script publish tag terriajs7
• PR to next: merge in master (needs care for translations and weblate), modify GH actions to branchname main, update README, change npm publish bot script publish tag (merge PR - Merge master into next #5723 - other actions not done)
• Rename next as main in GitHub (see renaming a branch)
• Make a local commit to main that is a merge from main into master (to get normal git history while allowing us to rename branches so that PRs to next stay as PRs to main)
• Check that this merge looks like PRing next to main, and then push this to main
• Set main as default branch in terriajs repo settings
• Rename master as terriajs7 in GitHub
• Update config of external services: netlify & weblate
• Release 8.0.0
• Release a new version of v7 with updated terriajs-server version
• Switch TerriaMap branches (see below)
• Switch over docs.terria.io to point to v8 docs
• Fix the ci-deploy.sh scripts of main and terriajs7

TerriaMap rollout:

• Merge this TerriaMap PR: translation keys prefix TerriaMap#534
• PR to master: modify GH actions branch names, update README, use latest terriajs@7
• PR to next: modify GH actions branch names, update README, merge V8 release TerriaMap#542
• Rename next as main in GitHub (see renaming a branch)
• Make a local commit to main that is a merge from main into master (to get normal git history while allowing us to rename branches so that PRs to next stay as PRs to main)
• Check that this merge looks like PRing next to main, and then push this to main
• Set main as default branch in TerriaMap repo settings
• Rename master as terriajs-v7 in GitHub
• Convert all catalogs in main to v8 - Convert all catalogs in 'main' to v8 #5743

[AnaBelgun]

This #5743 will be worked on independently.