Final steps
1. Update API stream for Update Assistant
This should only be done for stable releases.
(i.e. if not for betas and RCs).
Additional changes must be brought to the Distribution API repository to provide the best experience on the Update Assistant module:
- Add in the file releaseNotes.json the new version and the link to its release notes,
- Update the file autoupgrade.json to make the new release available for update.
If you needed to release a new version of the module Update Assistant, update the
autoupgrade_recommended
property as well. You may have to create a new entry if the new Update Assistant is compliant with a range of PrestaShop version that is unrelated to the existing ones.
Once this step is done and your changes have been merged, update the Release Tracker GitHub issue by ticking the “Available for update” box.
Application of changes check.
Please verify the contents of https://api.prestashop-project.org/autoupgrade. You might need to wait for the cache to be cleared.
API migration.
Update Assistant is using the Distribution API since the version 7.1. Before that, it was using an API only available from people of PrestaShop SA with specific rights.
2. Create Docker images for the new version
- Checkout the project, install the project and create a new branch
- Modify the file
versions.py
to add the new version and the related php matrix compatibility - Commit these changes
- Run
prestashop_docker.py generate
to generate the new Dockerfiles in the folderimages/
(See documentation) - Commit these changes
- Push to your fork or the original repository, create a PR and wait for the tests to pass before merging (see this example)
- Once the PR has been merged, a GitHub Action will publish the new images on Docker
Some other registries depend on this registry to be updated (like Docker internal images). The update will be automatic.
It may take a few hours for the images to be updated.
You can update the Release Tracker GitHub issue: step “Docker image” is done.
3. Go through the checklist
-
Check the PrestaShop localization packs are correct (only needed for major and minor releases):
- Repository
- Example download link (replace 8.1.1 with the version you just released)
-
Check the Distribution API content for fresh installs is correct:
- https://api.prestashop-project.org/prestashop features the latest release and its details are correct,
- https://api.prestashop-project.org/assets/prestashop/8.1.1/prestashop.xml lists the archive contents with the checksum of each file in it (replace 8.1.1 with the version you just released),
- https://api.prestashop-project.org/modules/8.1.1 features the right modules, and informations are correct (replace 8.1.1 with the version you just released),
- https://api.prestashop-project.org/autoupgrade shows the release among one or several compatibility range of Update Assistant (provided you allow updates to this version).
-
Check that the release note has been published on the Build Blog
-
Check that the latest release has an available docker image on the Docker repository
-
For 1.7.x releases, check the Addons API content for fresh installs is correct (replace 1.7.6.0 with the version you just released):
-
Check that if you try to install PrestaShop 1.7.5 from the archive, the installer suggests you install the latest version instead
4. Store the ZIP archive
Submit a Pull Request to add the ZIP archive to the Archives repository.
5. Improve the process
If during the process you encountered issues or there was some information not 100% clear, please improve this process documentation.
Congratulations!
The release is now complete, you can close the Release Tracker GitHub issue.