You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/maintainers-guide/processes/release/prestashop/_index.md
+19-18Lines changed: 19 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,28 +36,28 @@ Security patch releases contain security fixes for major security issues. Please
36
36
## Process overview
37
37
38
38
1.**[Perform preliminary tasks][preliminary-tasks]**: (click to see the full step)
39
-
39
+
40
40
Short summary:
41
-
42
-
-**Set up the new version on the PrestaShop Addons Marketplace and update native modules' compatibility.**
43
-
_To allow the PrestaShop Addons Marketplace and its API to serve modules compatible with this new PrestaShop version._
44
-
41
+
45
42
-**Update the version number in the Core.**
46
-
43
+
47
44
-**Make sure the default translation catalogue has been updated and pushed to Crowdin.**
48
45
_To make any new wordings translatable._
49
46
50
47
-**Lock the theme version.**
51
48
52
49
-**Make sure to trigger the release of the Upgrade module if necessary.**
53
-
54
-
-**Perform manual verifications.**
50
+
51
+
-**Perform manual verifications.**
55
52
_To make sure that the project is ready to be built._
56
53
54
+
-**Set up the new version on the PrestaShop Addons Marketplace and update native modules' compatibility.**
55
+
_To allow the PrestaShop Addons Marketplace and its API to serve modules compatible with this new PrestaShop version._
56
+
57
57
2.**[Create a new build][create-build]**: (click to see the full step)
58
58
59
59
Short summary:
60
-
60
+
61
61
-**Merge security PRs locally.**
62
62
_Any security PRs must be merged on a local branch before making them public._
63
63
@@ -66,7 +66,7 @@ Security patch releases contain security fixes for major security issues. Please
66
66
67
67
-**Push your work into a build branch.**
68
68
_Allows the base branch to continue receiving merges while your build is being validated._
69
-
69
+
70
70
-**Build and store the zip archive.**
71
71
_The ZIP archive contains the software (including third party dependencies) and compiled assets (Javascript and CSS), but not the development sources, dev dependencies & tests._
72
72
@@ -80,17 +80,18 @@ Security patch releases contain security fixes for major security issues. Please
80
80
_And publish the security advisories._
81
81
82
82
-**Merge the updated Changelog and Contributors list on GitHub.**
83
-
84
-
-**Tag the version using Git and publish the release on GitHub.**
85
-
86
-
-**Communicate.**
83
+
84
+
-**Tag the version using Git. Do not push it just yet.**
85
+
86
+
-**Communicate and push/publish the tag and the release on GitHub.**
87
+
_Make sure to link to the PrestaShop SA versions page from the GitHub release description to ease access to the latest built package of PrestaShop_
87
88
88
89
4.**[Final steps][final-steps]**: (click to see the full step)
89
90
90
91
Short summary:
91
92
92
-
-**Update API stream for 1-click upgrade.**
93
-
_So that the 1-Click Upgrade (autoupgrade) module becomes aware of the new release._
93
+
-**Update API stream for Update Assistant (1-click upgrade).**
94
+
_So that the Update Assistant (1-Click Upgrade / autoupgrade) module becomes aware of the new release._
94
95
95
96
-**Create Docker images for the new version.**
96
97
@@ -106,8 +107,8 @@ Security patch releases contain security fixes for major security issues. Please
Copy file name to clipboardExpand all lines: content/maintainers-guide/processes/release/prestashop/preliminary-tasks.md
+56-46Lines changed: 56 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,26 +9,12 @@ aliases:
9
9
10
10
Before you can start your build, you must make sure that the project is ready to be built.
11
11
12
-
## 1. Create the new version in Addons Marketplace and update native module compatibility
13
-
14
-
{{% notice warning %}}
15
-
**This step requires special rights ([doc to create a new version on Addons](https://www.notion.so/prestashopcorp/Create-the-new-version-in-the-Addons-Marketplace-update-module-compatibility-4aae19abe5b641f9a77e904cd913e50a?pvs=4)).**
16
-
17
-
Ask a maintainer from the PrestaShop Company with administrative rights on the Addons Marketplace to perform this step.
18
-
{{% /notice %}}
12
+
## 1. Make sure the version number has been updated in the Core
19
13
20
14
{{% notice note %}}
21
15
**This only needs to be done once per release.**
22
16
23
-
_(i.e. if done for a beta, it doesn't need to be performed again for the final release)._
24
-
{{% /notice %}}
25
-
26
-
## 2. Make sure the version number has been updated in the Core
27
-
28
-
{{% notice note %}}
29
-
**This only needs to be done once per release.**
30
-
31
-
PrestaShop does not support pre-release versioning yet. Any build of 1.7.6.0 will be identified as 1.7.6.0 regardless if the release is alpha, beta, RC or stable.
17
+
PrestaShop does not support pre-release versioning yet. Any build of 1.7.6.0 will be identified as 1.7.6.0 regardless of whether the release is alpha, beta, RC, or stable.
32
18
{{% /notice %}}
33
19
34
20
Check the following files and update them if necessary:
@@ -53,15 +39,15 @@ Check the following files and update them if necessary:
53
39
54
40
Make a pull request and have it merged.
55
41
56
-
Be careful: changing the version number has impacts on UI tests. You need to update the Distribution API to acknowledge the new version even though it does not exist yet, to allow UI tests to run. Submit a PR similar to [this example][pr-bump-dist-api] to do so.
42
+
Be careful: changing the version number impacts UI tests. To allow UI tests to run, you need to update the Distribution API to acknowledge the new version even though it does not exist yet. To do so, submit a PR similar to [this example][pr-bump-dist-api].
57
43
58
44
{{% notice tip %}}
59
45
If you're lost, check out [this example][bump-core-version-pr-example] from the 1.7.6.6 release.
## 3. Make sure the default translation catalogue has been updated and pushed to Crowdin
50
+
## 2. Make sure the default translation catalogue has been updated and pushed to Crowdin
65
51
66
52
{{% notice warning %}}
67
53
**This step requires special rights.**
@@ -75,51 +61,55 @@ Ask a maintainer from the PrestaShop Company with access to the Translation Tool
75
61
It is usually only done once per release as well.
76
62
{{% /notice %}}
77
63
78
-
1. [Use the command to extract wordings from the TranslationTool repository](https://github.com/PrestaShopCorp/TranslationTool/actions/workflows/create-default-catalog-pr.yml). This command will automatically generates a Pull Request on the PrestaShop/PrestaShop repository (author should be jarvis). It is important to note that this PR must be reviewed by a member of the content team.
79
-
https://github.com/PrestaShopCorp/TranslationTool is PRIVATE, and then you need a special right access to use it.
64
+
1. [Use the Github Action to extract wordings from the TranslationTool repository](<https://github.com/PrestaShopCorp/TranslationTool/actions/workflows/create-default-catalog-pr.yml>). This command will automatically generates a Pull Request on the PrestaShop/PrestaShop repository (author should be jarvis). It is important to note that this PR must be reviewed by a member of the content team.
65
+
<https://github.com/PrestaShopCorp/TranslationTool> is PRIVATE, and then you need special access rights to use it.
80
66
81
-
3. If the team content member requests wording corrections, they can be found either in the Prestashop CORE, a module or in the directory /mails of the Prestashop CORE.
67
+
2. If the team content member requests wording corrections, they can be found either in the PrestaShop CORE, a module, or in the directory /mails of the PrestaShop CORE.
82
68
83
-
4. If the correction occurs in a module, a release must be made, along with a bump in the composer.json of the CORE, before re-extracting.
69
+
3. If the correction occurs in a module, a release must be made, along with a bump in the composer.json of the CORE, before re-extracting.
84
70
85
-
5. If the wording to be corrected is found in /mails/themes/modern, you should first correct it in https://github.com/PrestaShop/mjml-theme-converter and the mail templates in the Prestashop CORE should also be regenerated (using https://github.com/PrestaShop/mjml-theme-converter ).
71
+
4. If the wording to be corrected is found in `/mails/themes/modern`, you should first correct it in <https://github.com/PrestaShop/mjml-theme-converter> and the mail templates in the PrestaShop CORE should also be regenerated (using <https://github.com/PrestaShop/mjml-theme-converter> ).
86
72
87
-
6. Once all the wordings have been corrected, validated and merged, [a Github Action can be used on the TranslationTool repository](https://github.com/PrestaShopCorp/TranslationTool/actions/workflows/push_catalog_to_crowdin.yml) to push the catalogs to Crowdin (the repository need right access).
73
+
5. Once all the wordings have been corrected, validated and merged, [a Github Action can be used on the TranslationTool repository](https://github.com/PrestaShopCorp/TranslationTool/actions/workflows/push_catalog_to_crowdin.yml) to push the catalogs to Crowdin (the repository need right access).
88
74
89
-
## 4. Lock the theme version.
75
+
## 3. Lock the theme version
90
76
91
77
{{% notice tip %}}
92
-
You can do this step using Git or directly on GitHub on the next step.
78
+
You can do this step using Git or directly on GitHub in the next step.
93
79
{{% /notice %}}
94
80
95
81
The theme has been moved outside of the Core repository since version 8.0.0.
96
82
97
-
* Create git tag on the Theme repository
83
+
* Create a git tag on the Theme repository
84
+
85
+
This tag is needed to lock the theme version when a new release is built.
98
86
99
-
When a new release is built, this tag is needed to lock the theme version.
87
+
* [Tag][git-tag] the new version:
100
88
101
-
- [Tag][git-tag] the new version:
102
89
```bash
103
90
git tag 2.0.0-rc1 # replace with your version
104
91
```
105
-
- Push the tag:
92
+
93
+
* Push the tag:
94
+
106
95
```bash
107
96
git push 2.0.0-rc1 # replace with your version
108
97
```
109
98
110
99
* Update `composer.lock` to target the new tag
111
100
112
-
## 5. Make sure to trigger the release of the Upgrade module if necessary.
101
+
## 4. Make sure to trigger the release of the Upgrade module if necessary
113
102
114
-
Some releases do need an update of the [Autoupgrade][autoupgrade] module, some do not. For example if the MySQL schema of the database has been updated between two versions of PrestaShop, a schema update SQL script is needed, and it has to be to the [list][autoupgrade-sql-list].
103
+
Some releases need an update of the [Update Assistant][autoupgrade] module, and some do not. For example, if the MySQL database schema has been updated between two versions of PrestaShop, a schema update SQL script is needed, and it has to be added to the [list][autoupgrade-sql-list].
115
104
116
105
Please verify whether or not this new version of PrestaShop requires
117
-
- to modify the source code of the Autoupgrade module
118
-
- to publish a new version (using the up-to-date content of the source code) of the Autoupgrade module
119
106
120
-
If yes, please follow [the release process of the Autoupgrade module][autoupgrade-release-process].
107
+
* to modify the source code of the Update Assistant (autoupgrade) module
108
+
* to publish a new version (using the up-to-date content of the source code) of the Update Assistant (autoupgrade) module
109
+
110
+
If yes, please follow [the release process of the Update Assistant module][autoupgrade-release-process].
121
111
122
-
## 6. Manual verifications
112
+
## 5. Manual verifications
123
113
124
114
Make sure that in the current branch:
125
115
@@ -132,11 +122,15 @@ Make sure that in the current branch:
132
122
* All controllers are secured by annotations, and legacy link are provided for Symfony routes (starting from 9.0.x this step is obsolete as it is checked in the CI already):
* There are no known vulnerabilities in composer dependencies using `composer audit` to check vulnerabilities.
139
129
130
+
{{% notice warning %}}
131
+
This repository is now archived. Use composer audit instead
132
+
{{% /notice %}}
133
+
140
134
* _(Minor and major releases only)_ – No important `@todo` annotations have been left forgotten in new code
141
135
142
136
* All new hooks have been [registered][register-new-hook]
@@ -154,22 +148,38 @@ Make sure that in the current branch:
154
148
```bash
155
149
composer outdated -D "prestashop/*"
156
150
```
157
-
151
+
158
152
* [Nightly builds][nightly-build-board] are green
159
153
154
+
## 6. Create the new version in the PrestaShop Marketplace and update native module compatibility
155
+
156
+
{{% notice warning %}}
157
+
**This step requires special rights ([doc to create a new version on PrestaShop Marketplace](https://www.notion.so/prestashopcorp/Create-the-new-version-in-the-Addons-Marketplace-update-module-compatibility-c665ab0777204e2d95ce6df22b140747)).**
158
+
159
+
Ask a maintainer from the PrestaShop Company with administrative rights on the PrestaShop Marketplace to perform this step.
160
+
{{% /notice %}}
161
+
162
+
{{% notice note %}}
163
+
**This only needs to be done once per release.**
164
+
165
+
_(i.e. ifdonefor a beta, it doesn't need to be performed again for the final release)._
166
+
{{% /notice %}}
160
167
161
168
{{% notice warning %}}
162
169
If any of above verifications fails, it MUST be addressed in a Pull Requests and merged before moving forward.
163
170
{{% /notice %}}
164
171
172
+
The preliminary steps are completed, you can now proceed to the [build steps][create-build].
3. Use the following command to start the Hugo server:
60
+
52
61
```bash
53
62
docker-compose up
54
63
```
55
64
56
65
By default, the server will run on port `1313`. You can specify a different port by setting the `HUGO_SERVER_PORT` environment variable before running the command. For example:
66
+
57
67
```bash
58
68
HUGO_SERVER_PORT=3000 docker-compose up
59
69
```
60
70
61
-
4. Access the site in your browser at `http://localhost:<PORT>`, replacing `<PORT>` with the port you defined (default is `1313`).
71
+
4. Access the site in your browser at `http://localhost:<PORT>`, replacing `<PORT>` with the port you defined (default is `1313`).
0 commit comments