deploy: b0b5d8f

Author: matks

data-transparency/index.html

@@ -329,7 +329,7 @@ <h5 id="option-1-do-not-use-_distribution-api-client_">Option 1: Do not use <em>
 <h5 id="option-2-disable-data-sharing">Option 2: Disable data sharing</h5>
 <p>Set the <code>PS_URL_TRACKING</code> environment variable to <code>false</code>. You can do this using the <code>SetEnv</code> Apache directive in a .htaccess file, for example.</p>
 <h2 id="data-collected-through-the-update-assistant-module">Data collected through the update assistant module</h2>
-<p>Technical data are collected by the PrestaShop project teams through the Update assistant module (<a href="https://github.com/PrestaShop/autoupgrade">link</a>).</p>
+<p>Technical data are collected by the PrestaShop project teams through the Update Assistant module (<a href="https://github.com/PrestaShop/autoupgrade">link</a>).</p>
 <p>These data helps the module&rsquo;s contributors to better understand usage and any associated errors. The aim is to enable continuous optimization of the Update assistant module, based on good data-driven decisions.</p>
 <h3 id="definition">Definition</h3>
 <p>The User is informed that the following terms or expressions will have, whenever they begin with a capital letter in the body of the Policy (including its appearances and its preamble), whether they are used in the singular or in the plural, masculine or feminine, the meaning attributed to them below:</p>
@@ -364,8 +364,8 @@ <h3 id="purposes--legal-bases">Purposes &amp; legal bases</h3>
 </table>
 <p>We collect technical data on the Update assistant module with the following tools:</p>
 <ul>
-<li><strong>Segment</strong> - Collection of technical data related to the use of the Update assistant module. This data will help us better understand user actions on the module (clicks on CTAs, upgrade channels used, number of successful upgrades, number of failed upgrades, etc.). Only technical data will be collected, no personal data or data allowing the identification of a physical person will be recovered.</li>
-<li><strong>Sentry -</strong> A technical report will be collected in the event of upgrade or rollback errors, upon voluntary action by the user (via a click on the &ldquo;Report a bug&rdquo; CTA). This data will help us better understand the nature of the errors (module version, PrestaShop version, PHP version, etc.).</li>
+<li><strong>Segment</strong> - Collection of technical data related to the use of the Update assistant module. This data will help us better understand user actions on the module (clicks on CTAs, update channels used, number of successful updates, number of failed updates, etc.). Only technical data will be collected, no personal data or data allowing the identification of a physical person will be recovered.</li>
+<li><strong>Sentry -</strong> A technical report will be collected in the event of update or restore errors, upon voluntary action by the user (via a click on the &ldquo;Report a bug&rdquo; CTA). This data will help us better understand the nature of the errors (module version, PrestaShop version, PHP version, etc.).</li>
 </ul>
 <h3 id="who-process-your-data">Who process your data?</h3>
 <h4 id="processing-of-your-data-by-prestashop-employees-and-our-mother-company">Processing of your Data by PrestaShop employees and our Mother Company</h4>

index.xml

@@ -124,12 +124,10 @@ Make certain you have go for publish! Also, avoid starting this process after 4
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
 
       <guid>https://www.prestashop-project.org/maintainers-guide/processes/release/prestashop/final-steps/</guid>
-      <description>Final steps 1. Update API stream for 1-click upgrade This should only be done for stable releases.
+      <description>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).
- 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.</description>
+ 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.</description>
     </item>
 
     <item>
@@ -239,14 +237,14 @@ Requirements Mandatory requirements The module should be valid which means:</des
     </item>
 
     <item>
-      <title>How to release a new AutoUpgrade version</title>
+      <title>How to release a new Update Assistant version</title>
       <link>https://www.prestashop-project.org/maintainers-guide/processes/release/autoupgrade/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
 
       <guid>https://www.prestashop-project.org/maintainers-guide/processes/release/autoupgrade/</guid>
-      <description>Release a new version of AutoUpgrade module The AutoUpgrade module is released following the same process as the native modules.
-However, after the release has been published, a last step is necessary.
-Mark the new version as latest The AutoUpgrade module is able to detect whether a new version is available. If it detects a new version is available it will suggest to user to upgrade itself to the new higher version.</description>
+      <description>Release a new version of Update Assistant New versions of Update Assistant (autoupgrade module) are released following the same process as the native modules.
+However, after the release has been published, more steps can be necessary.
+Mark the new version as latest Update Assistant can determine whether a newer version is recommended. When the current version is older than the recommended one, the module suggests upgrading to the latest version. Given the critical nature of the process, this check ensures updates are performed with all the latest improvements and bug fixes.</description>
     </item>
 
     <item>

maintainers-guide/images/autoupgrade-update-needed.png

@@ -3,10 +3,10 @@
 
 <head>
 	<meta charset="utf-8">
-<title>How to release a new AutoUpgrade version | PrestaShop Project - Open Source e-Commerce platform</title>
-<meta name="description" content="Release a new version of AutoUpgrade module The AutoUpgrade module is released following the same process as the native modules.
-However, after the release has been published, a last step is necessary.
-Mark the new version as latest The AutoUpgrade module is able to detect whether a new version is available. If it detects a new version is available it will suggest to user to upgrade itself to the new higher version."/>
+<title>How to release a new Update Assistant version | PrestaShop Project - Open Source e-Commerce platform</title>
+<meta name="description" content="Release a new version of Update Assistant New versions of Update Assistant (autoupgrade module) are released following the same process as the native modules.
+However, after the release has been published, more steps can be necessary.
+Mark the new version as latest Update Assistant can determine whether a newer version is recommended. When the current version is older than the recommended one, the module suggests upgrading to the latest version. Given the critical nature of the process, this check ensures updates are performed with all the latest improvements and bug fixes."/>
 
 <link rel="canonical" href="https://www.prestashop-project.org/maintainers-guide/processes/release/autoupgrade/" itemprop="url" />
 
@@ -27,18 +27,18 @@
 
 
 <!-- Open Graph image and Twitter Card metadata -->
-<meta name="twitter:title" content="How to release a new AutoUpgrade version"/>
-<meta name="twitter:description" content="Release a new version of AutoUpgrade module The AutoUpgrade module is released following the same process as the native modules.
-However, after the release has been published, a last step is necessary.
-Mark the new version as latest The AutoUpgrade module is able to detect whether a new version is available. If it detects a new version is available it will suggest to user to upgrade itself to the new higher version."/>
-<meta property="og:title" content="How to release a new AutoUpgrade version" />
-<meta property="og:description" content="Release a new version of AutoUpgrade module The AutoUpgrade module is released following the same process as the native modules.
-However, after the release has been published, a last step is necessary.
-Mark the new version as latest The AutoUpgrade module is able to detect whether a new version is available. If it detects a new version is available it will suggest to user to upgrade itself to the new higher version." />
+<meta name="twitter:title" content="How to release a new Update Assistant version"/>
+<meta name="twitter:description" content="Release a new version of Update Assistant New versions of Update Assistant (autoupgrade module) are released following the same process as the native modules.
+However, after the release has been published, more steps can be necessary.
+Mark the new version as latest Update Assistant can determine whether a newer version is recommended. When the current version is older than the recommended one, the module suggests upgrading to the latest version. Given the critical nature of the process, this check ensures updates are performed with all the latest improvements and bug fixes."/>
+<meta property="og:title" content="How to release a new Update Assistant version" />
+<meta property="og:description" content="Release a new version of Update Assistant New versions of Update Assistant (autoupgrade module) are released following the same process as the native modules.
+However, after the release has been published, more steps can be necessary.
+Mark the new version as latest Update Assistant can determine whether a newer version is recommended. When the current version is older than the recommended one, the module suggests upgrading to the latest version. Given the critical nature of the process, this check ensures updates are performed with all the latest improvements and bug fixes." />
 <meta property="og:type" content="article" />
 <meta property="og:url" content="https://www.prestashop-project.org/maintainers-guide/processes/release/autoupgrade/" /><meta property="article:section" content="maintainers-guide" />
 
-<meta property="article:modified_time" content="2023-09-12T09:42:53+02:00" />
+<meta property="article:modified_time" content="2025-05-09T09:51:47+01:00" />
 
 
 
@@ -275,7 +275,7 @@
 
 
 
-        <li class="breadcrumb-item active" aria-current="page">How to release a new AutoUpgrade version</li>
+        <li class="breadcrumb-item active" aria-current="page">How to release a new Update Assistant version</li>
 
 
   </ol>
@@ -287,19 +287,34 @@
 
 
       <div class="col-xl ml-auto">
-        <div class="content"><h1 id="release-a-new-version-of-autoupgradehttpsgithubcomprestashopautoupgrade-module">Release a new version of <a href="https://github.com/PrestaShop/autoupgrade/">AutoUpgrade</a> module</h1>
-<p>The AutoUpgrade module is released following <a href="/maintainers-guide/processes/release/native-module/">the same process as the native modules</a>.</p>
-<p>However, after the release has been published, a last step is necessary.</p>
+        <div class="content"><h1 id="release-a-new-version-of-update-assistant">Release a new version of Update Assistant</h1>
+<p>New versions of Update Assistant (<a href="https://github.com/PrestaShop/autoupgrade/"><code>autoupgrade</code> module</a>) are released following <a href="/maintainers-guide/processes/release/native-module/">the same process as the native modules</a>.</p>
+<p>However, after the release has been published, more steps can be necessary.</p>
 <h2 id="mark-the-new-version-as-latest">Mark the new version as latest</h2>
-<p>The AutoUpgrade module is able to detect whether a new version is available. If it detects a new version is available it will suggest to user to upgrade itself to the new higher version.</p>
-<p>For example if user is using module 4.16.1 and it detects that version 4.16.3 has been published, the module will inform the user that he is using an outdated version and should perform a module upgrade to version 4.16.3 .</p>
-<p>The detection mechanism is a simple verification of the file <a href="https://api.prestashop.com/xml/channel.xml">https://api.prestashop.com/xml/channel.xml</a> .</p>
-<p>Consequently when a new version of the AutoUpgrade module is published, the file <a href="https://api.prestashop.com/xml/channel.xml">https://api.prestashop.com/xml/channel.xml</a> must be modified. It is stored in the PrestaShop API repository.</p>
-
-<div class="notices warning" ><p><strong>This step requires special rights.</strong></p>
-<p>Ask a maintainer from the PrestaShop Company with administrative rights on the PrestaShop API repository to perform this step.</p>
-</div>
-
+<p>Update Assistant can determine whether a newer version is recommended. When the current version is older than the recommended one, the module suggests upgrading to the latest version. Given the critical nature of the process, this check ensures updates are performed with all the latest improvements and bug fixes.</p>
+<p>For example, if a user is using version 7.0.0 and version 7.0.1 has been released, the module will inform the user that they are using an outdated version and should update.</p>
+<img src="../../../images/autoupgrade-update-needed.png" alt="Update of the module needed">
+<p>This detection mechanism is based on the contents of the <a href="https://api.prestashop-project.org/autoupgrade"><code>/autoupgrade</code></a> endpoint of the Distribution API.</p>
+<p>The file maps ranges of PrestaShop versions to a recommended version of Update Assistant. This allows the module to:</p>
+<ul>
+<li>Warn users when their current version is outdated,</li>
+<li>Ensure updates are only allowed if the PrestaShop version falls within one of the defined ranges.</li>
+</ul>
+<p>To enable this check, update the contents of the closest exising version entry in the file <a href="https://github.com/PrestaShop/distribution-api/blob/main/public/json/autoupgrade.json">autoupgrade.json in the Distribution API repository</a>. For instance:</p>
+<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="p">{</span>
+    <span class="nt">&#34;prestashop_min&#34;</span><span class="p">:</span> <span class="s2">&#34;1.7.0.0&#34;</span><span class="p">,</span>
+    <span class="nt">&#34;prestashop_max&#34;</span><span class="p">:</span> <span class="s2">&#34;8.2.1&#34;</span><span class="p">,</span>
+    <span class="nt">&#34;autoupgrade_recommended&#34;</span><span class="p">:</span> <span class="p">{</span>
+        <span class="nt">&#34;last_version&#34;</span><span class="p">:</span> <span class="s2">&#34;7.0.0&#34;</span><span class="p">,</span>
+        <span class="nt">&#34;download&#34;</span><span class="p">:</span> <span class="p">{</span>
+            <span class="nt">&#34;link&#34;</span><span class="p">:</span> <span class="s2">&#34;https://github.com/PrestaShop/autoupgrade/releases/download/v7.0.0/autoupgrade-v7.0.0.zip&#34;</span><span class="p">,</span>
+            <span class="nt">&#34;md5&#34;</span><span class="p">:</span> <span class="s2">&#34;c0d83aea9dbb03d7f2f698d011144d43&#34;</span>
+        <span class="p">},</span>
+        <span class="nt">&#34;changelog&#34;</span><span class="p">:</span> <span class="s2">&#34;https://build.prestashop-project.org/news/2025/autoupgrade-v7.0-release/&#34;</span>
+    <span class="p">}</span>
+<span class="p">}</span>
+</code></pre></div><p>If the new module version supports a different range of PrestaShop versions, you’ll need to add a new entry.</p>
+<p>The updated file will be published as part of the API release.</p>
 </div>
       </div>
     </div>

maintainers-guide/processes/release/autoupgrade/index.html

@@ -312,7 +312,7 @@
 
 
 					<li>
-					<a href="/maintainers-guide/processes/release/autoupgrade/" >How to release a new AutoUpgrade version</a>
+					<a href="/maintainers-guide/processes/release/prestashop/" >How to release a new PrestaShop version</a>
 
 					</li>
 
@@ -326,7 +326,7 @@
 
 
 					<li>
-					<a href="/maintainers-guide/processes/release/prestashop/" >How to release a new PrestaShop version</a>
+					<a href="/maintainers-guide/processes/release/autoupgrade/" >How to release a new Update Assistant version</a>
 
 					</li>
 

maintainers-guide/processes/release/index.html

@@ -19,14 +19,14 @@ Requirements Mandatory requirements The module should be valid which means:</des
     </item>
 
     <item>
-      <title>How to release a new AutoUpgrade version</title>
+      <title>How to release a new Update Assistant version</title>
       <link>https://www.prestashop-project.org/maintainers-guide/processes/release/autoupgrade/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
 
       <guid>https://www.prestashop-project.org/maintainers-guide/processes/release/autoupgrade/</guid>
-      <description>Release a new version of AutoUpgrade module The AutoUpgrade module is released following the same process as the native modules.
-However, after the release has been published, a last step is necessary.
-Mark the new version as latest The AutoUpgrade module is able to detect whether a new version is available. If it detects a new version is available it will suggest to user to upgrade itself to the new higher version.</description>
+      <description>Release a new version of Update Assistant New versions of Update Assistant (autoupgrade module) are released following the same process as the native modules.
+However, after the release has been published, more steps can be necessary.
+Mark the new version as latest Update Assistant can determine whether a newer version is recommended. When the current version is older than the recommended one, the module suggests upgrading to the latest version. Given the critical nature of the process, this check ensures updates are performed with all the latest improvements and bug fixes.</description>
     </item>
 
   </channel>