-
Notifications
You must be signed in to change notification settings - Fork 1
Description
✅ Summary
Minimum Jahia version
We aim at reducing the possible deployment matrices by regularly bumping up the minimum Jahia version when releasing new versions of our modules.
When creating a Release ticket for a module, consult with your PM to identify the new minimum Jahia version this module must be associated with.
The default guideline is for a new module release to be compatible with the 2 previous releases.
Current Jahia Version: 8.2.0.0 (version currently in the POM)
Desired Jahia Version: 8.2.0.0
📜 Testing matrix
We aim at clearly documenting the possible deployment scenarios in a matrix and specify which ones are expected to be tested or not.
In the testing matrix, always use the latest patch version of a particular release
The following combinations should be validated:
Jahia 8.2.0.x
- Jahia 8.2.0.x
- javascript-modules-engine 0.6.0 (Artifact)
Luxe is not compatible with Jahia 8.2.0.x (discovered during testing)
Jahia 8.2.1.x
- Jahia 8.2.1.x
- javascript-modules-engine 0.6.0 (Artifact)
- luxe-jahia-demo
0.6.0 (Artifact)0.6.1 (Artifact) - luxe-prepackaged-site
0.6.0 (Artifact)0.6.1 (Artifact)
ℹ️ If you are releasing for the main branch of a module, make sure to complete the checklist below when working on the ticket.
✏️ Prepare checklist
- All other tickets within that milestone are are closed
- Testing matrix and Minimum Jahia version are detailed
- Jahia-parent (minimum Jahia version) was updated if requested in the ticket
- The release workflow will publish a slack notification
- Release creation has been triggered from the Github Release UI (https://github.com/Jahia/[module-repo]/releases/new)
🚦 Tests checklist
General
- Manual tests detailing testing steps for validating the release of this module are present on Testrail
-
Automated tests using the release artifacts were executed
Module migration
- Upgrade from the previous released version of the module was tested
- The upgrade did not require clearing the browser cache (i.e. missing labels)
While Testing
- Follow the new Getting Started guide and see if it works https://github.com/Jahia/javascript-modules/tree/main/docs/1-getting-started
- No warnings or errors are present in the browser console when testing the module
- No warnings or errors are present in Jahia logs when testing the module (incl. migration)
-
Verified tickets present in the release are actually included in the release artifact - testrail suite has been executed https://jahia.testrail.net/index.php?/runs/view/182259&group_by=cases:section_id&group_order=asc
After Testing
- Tested combinations (Jahia versions, modules versions) are listed in this released ticket
- Tested scenarios not detailed in Testrail are listed in this release ticket
-
The version was updated in the Selenium integration tests
🚀 Publication checklist
- The release changelog was prepared
- In case of a major release, a Breaking Changes section is present in the Changelog
- The artifact was released on Nexus
- If applicable, corresponding academy pages were published
- The module was published on the store
-
The modules releases log page on the Academy was updated - A message was published on slack #releases channel
-
The milestone on GitHub was closed