Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update module autoupgrade name to Update assistant #1842

Open
wants to merge 1 commit into
base: 8.x
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion basics/keeping-up-to-date/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Note that once an upgrade has started, there is no way to rollback the changes.
- Apply the new files by copy-pasting them in the production folder.
- Run the database upgrade.

This could be enough for completing an upgrade, but additional tasks like cleanup and modules upgrade will bring you stability and security. This is how the `autoupgrade` module works.
This could be enough for completing an upgrade, but additional tasks like cleanup and modules upgrade will bring you stability and security. This is how the `Update assistant` module works.

### Migration

Expand Down
6 changes: 3 additions & 3 deletions basics/keeping-up-to-date/upgrade-module/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ aliases:

# Upgrade module

Also known as the "Autoupgrade module" or the "1-click upgrade module", PrestaShop upgrade assistant aims to automatize the upgrade process.
Also known as the "Autoupgrade module" or the "1-click upgrade module", PrestaShop update assistant aims to automatize the upgrade process.

Details on how to use the web interface are documented in [Keep up-to-date: Upgrade Assistant page]({{< ref "/8/basics/keeping-up-to-date/use-autoupgrade-module.md" >}}).
Details on how to use the web interface are documented in [Keep up-to-date: Update assistant page]({{< ref "/8/basics/keeping-up-to-date/use-autoupgrade-module.md" >}}).

{{% children /%}}

## How to download it

You can download it from [the module GitHub repository](https://github.com/PrestaShop/autoupgrade/releases) or from your shop administration panel.
You can download it from [the module GitHub repository](https://github.com/PrestaShop/autoupgrade/releases) or from your shop administration panel.
18 changes: 9 additions & 9 deletions basics/keeping-up-to-date/upgrade-module/upgrade-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ aliases:

# Module CLI

The Autoupgrade module is accessible via `cli`. Its advantages is to be used in conjunction with a CI/CD pipeline to automate your upgrade process.
The Update assistant module is accessible via `cli`. Its advantages is to be used in conjunction with a CI/CD pipeline to automate your upgrade process.
It can be aswell used manually via regular `cli` to avoid regular configuration limits on Apache or Nginx (`php-cgi`, `php-fpm` limitations such as `memory_limit`, `max_execution_time`, ...).

## Upgrade CLI
Expand Down Expand Up @@ -63,23 +63,23 @@ $ php modules/autoupgrade/cli-rollback.php --dir=admin-dev --backup=V1.7.5.1_201

To upgrade your PrestaShop store to the latest version using the command line interface, follow the steps outlined below. Make sure to execute all commands from the root directory of your PrestaShop installation and replace `admin-dev` with the name of your back office directory.

### Step 1: Uninstall and remove the old autoupgrade module
### Step 1: Uninstall and remove the old Update assistant module

1. Uninstall the old AutoUpgrade module:
1. Uninstall the old Update assistant module:

`php bin/console prestashop:module uninstall autoupgrade`

2. Remove the old module's directory:

`rm -rf modules/autoupgrade`

### Step 2: Install the new autoupgrade module
### Step 2: Install the new Update assistant module

1. Download the latest version of the autoupgrade module and place it in the /modules directory:
1. Download the latest version of the Update assistant module and place it in the /modules directory:

`curl -L https://github.com/PrestaShop/autoupgrade/releases/latest/download/autoupgrade.zip -o modules/autoupgrade.zip && cd modules && unzip autoupgrade.zip && cd -`

2. Install the new version of the autoupgrade module:
2. Install the new version of the Update assistant module:

`php bin/console prestashop:module install autoupgrade`

Expand All @@ -90,14 +90,14 @@ To upgrade your PrestaShop store to the latest version using the command line in
`curl -L https://github.com/PrestaShop/PrestaShop/releases/download/8.0.2/prestashop_8.0.2.zip -o admin-dev/autoupgrade/download/prestashop.zip`
`curl -L https://github.com/PrestaShop/PrestaShop/releases/download/8.0.2/prestashop_8.0.2.xml -o admin-dev/autoupgrade/download/prestashop.xml`

### Step 4: Configure the autoupgrade module
### Step 4: Configure the Update assistant module

1. Create a configuration file for the AutoUpgrade module to use the local archive. Adjust the settings as needed:
1. Create a configuration file for the Update assistant module to use the local archive. Adjust the settings as needed:

`echo "{\"channel\":\"archive\",\"archive_prestashop\":\"prestashop.zip\",\"archive_num\":\"8.0.2\", \"archive_xml\":\"prestashop.xml\", \"PS_AUTOUP_CHANGE_DEFAULT_THEME\":0, \"skip_backup\": 1}" > modules/autoupgrade/config.json`


2. Apply the configuration to the `autoupgrade` module:
2. Apply the configuration to the `Update assistant` module:

`php modules/autoupgrade/cli-updateconfig.php --from=modules/autoupgrade/config.json --dir=admin-dev`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,6 @@ In order to work properly, the upgrade module needs to write some files to your

- `backup`: Folder in which the current state of the shop will be saved before upgrade. It contains files archive, DB structure & data.
- `download`: Destination folder of the downloaded PrestaShop archive, before unzip.
- `latest`: Working directory of the autoupgrade. This is where the "lastest" version of PrestaShop will be unziped, before copy.
- `latest`: Working directory of the Update assistant. This is where the "lastest" version of PrestaShop will be unziped, before copy.
- `modules`: Folder where you can put an archive of a module. This one will be used when upgrading modules.
- `tmp`: Temporary resources not specifically used for upgrade. For instance, logs will be stored in that folder.
12 changes: 6 additions & 6 deletions basics/keeping-up-to-date/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,21 @@ Learn [how to backup your shop]({{< ref "/8/basics/keeping-up-to-date/backup" >}

There are a few ways of upgrading the PrestaShop store. This chapter provides information about two methods of getting the software to the latest version.

## Upgrade assistant module (formerly 1-click upgrade module)
## Update assistant module (formerly 1-click upgrade module)

You can use provided `autoupgrade` module to upgrade your store to the newest version using web interface. You can read more about the module and how to use it [here]({{< ref "/8/basics/keeping-up-to-date/use-autoupgrade-module" >}}).
You can use provided `Update assistant` module to upgrade your store to the newest version using web interface. You can read more about the module and how to use it [here]({{< ref "/8/basics/keeping-up-to-date/use-autoupgrade-module" >}}).

## Upgrade assistant module (formerly 1-click upgrade module) - CLI method
## Update assistant module (formerly 1-click upgrade module) - CLI method

Upgrade assistant module (autoupgrade) is fully accessible through `cli`. You can read all the details [here]({{< ref "/8/basics/keeping-up-to-date/upgrade-module/upgrade-cli" >}}).
Update assistant module (autoupgrade) is fully accessible through `cli`. You can read all the details [here]({{< ref "/8/basics/keeping-up-to-date/upgrade-module/upgrade-cli" >}}).

## Manual upgrade

{{% notice warning %}}
**Important**

Manual upgrade without `autoupgrade` module is not possible at the moment. We recommend using [cli]({{< ref "/8/basics/keeping-up-to-date/upgrade-module/upgrade-cli" >}})
mechanism from the upgrade assistant module.
Manual upgrade without `Update assistant` module is not possible at the moment. We recommend using [cli]({{< ref "/8/basics/keeping-up-to-date/upgrade-module/upgrade-cli" >}})
mechanism from the update assistant module.
{{% /notice %}}

### Release download
Expand Down
8 changes: 4 additions & 4 deletions basics/keeping-up-to-date/use-autoupgrade-module.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
menuTitle: Use the Upgrade Assistant
title: How to use the Upgrade Assistant
menuTitle: Use the Update assistant
title: How to use the Update assistant
weight: 40
---

# How to upgrade PrestaShop using the Upgrade Assistant
# How to upgrade PrestaShop using the Update assistant

Also known as the "Autoupgrade module" or the "1-click upgrade module", PrestaShop upgrade assistant aims to automatize the upgrade process.
Also known as the "Autoupgrade module" or the "1-click upgrade module", PrestaShop Update assistant aims to automatize the upgrade process.

It is available from your shop administration panel. It executes the [upgrade process]({{< ref "/8/basics/keeping-up-to-date/upgrade.md" >}}) automatically, and is available for almost all versions of PrestaShop.

Expand Down
2 changes: 1 addition & 1 deletion contribute/contribution-guidelines/pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ If no issue is linked to your Pull Request, maintainers might ask you to create

This field should contain links to related PRs in other repositories.

If your Pull Request modifies database structure or adds new configuration fields, you should also provide a PR for [autoupgrade module](https://github.com/PrestaShop/autoupgrade).
If your Pull Request modifies database structure or adds new configuration fields, you should also provide a PR for [Update assistant module](https://github.com/PrestaShop/autoupgrade).

If your Pull Request needs a theme change to work, you should provide [hummingbird](https://github.com/PrestaShop/hummingbird) and [classic-theme](https://github.com/PrestaShop/classic-theme) PR.

Expand Down
2 changes: 1 addition & 1 deletion development/architecture/file-structure/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ This directory is named `admin-dev` when using PrestaShop from source code, and

It contains the following subdirectories:

- `/autoupgrade`: scratch directory for the 1-click upgrade module
- `/autoupgrade`: scratch directory for the Update assistant module
- `/backups`: contains database backups generated from the Back office
- `/export`: contains data export files
- `/filemanager`: sources for the Back office file manager
Expand Down
2 changes: 1 addition & 1 deletion development/components/hook/register-new-hook.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Add new hooks at the bottom of the list, as hooks are registered sequentially.

The previous step only adds the hook to _new_ shops. We also need to register the hook to shops that upgrade from a previous version.

The last step is to insert the new hooks in the `ps_hooks` table using the upgrade system. Locate the X.Y.Z.sql file that refers to the PrestaShop version that will include your change: for instance, if the release expected to include this change is `1.7.5.0`, locate that file in the `upgrade/sql` folder from the [autoupgrade](https://github.com/PrestaShop/autoupgrade) module.
The last step is to insert the new hooks in the `ps_hooks` table using the upgrade system. Locate the X.Y.Z.sql file that refers to the PrestaShop version that will include your change: for instance, if the release expected to include this change is `1.7.5.0`, locate that file in the `upgrade/sql` folder from the [Update assistant](https://github.com/PrestaShop/autoupgrade) module.

{{% notice tip %}}
This process is explained here: [Structure and content upgrades]({{< ref "/8/development/database/structure.md#structure-and-content-upgrades" >}})
Expand Down
Loading