Skip to content

Commit

Permalink
Merge pull request #1705 from sowbiba/autoupgrade-from-local-source
Browse files Browse the repository at this point in the history
Doc for Autoupgrade a module from local source
  • Loading branch information
kpodemski authored Aug 14, 2023
2 parents 07642f6 + 23f887a commit 72020b1
Showing 1 changed file with 9 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,14 @@ Classes are gathered by responsibilities:
- Classes interacting with PrestaShop core
- Tasks (Can be considered as controllers for upgrade, rollback etc.)

## Upgrade modules from local source

During the upgrade process, we check for new module versions in the PrestaShop Marketplace. If there is one, we download it and then upgrade it.

Developers must release and push their module to the Marketplace in order to test the upgrade process, which is inconvenient. In order to simplify the testing process, you can place the ZIP file of your module in `/ADMIN_DIR/autoupgrade/modules/MODULE_NAME.zip`. This will allow you to use your local version for upgrading purposes.

In case your local archive with a module fails to work, the latest version will be downloaded from the Marketplace.

## Local temporary assets

In order to work properly, the upgrade module needs to write some files to your filesystem server. These files are stored in the following folders, all available in the `<admin folder>/autoupgrade` path.
Expand All @@ -89,4 +97,5 @@ 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.
- `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.

0 comments on commit 72020b1

Please sign in to comment.