Final steps
1. Update API stream for 1-click upgrade
This should only be done for stable releases.
(i.e. if not for betas and RCs).
This step requires special rights.
Ask a maintainer from the PrestaShop Company with administrative rights on the PrestaShop API repository to perform this step.
Here is an example of a PR that introduces a new version https://stash.prestashop.com/projects/PA/repos/xml/pull-requests/138/diff:
- you will need to add the new XML checksum file that was generated with the zip archive, this XML file should be named after the version released (ex: for
8.1.2
->8.1.2.xml
) - the
channel.xml
file needs to be updated, thebranch
node matching the minor version being released must be updated to indicate- the latest patch version
- the link to the archive for this patch version
- the md5 checksum of this archive file
- the link to the build article for this patch version
For new major/minor version you will have to create a new dedicated branch node.
Once this step is done, update the Release Tracker GitHub issue by ticking the “Available for upgrade” box.
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 API content for auto-upgrade module is correct:
- channel.xml
- 8.1.1.xml (replace with the version you have just released)
-
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)
-
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):
-
For 8.x releases, check the Distribution API content for fresh installs is correct:
- https://api.prestashop-project.org/prestashop features the latest release, and informations are correct
- 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)
-
Check that if you try to install PrestaShop 1.7.5 from the archive, the installer suggests you install the latest version instead
-
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
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.