Adds documentation for maxLogs option in updater

koderzi · web-flow · commit f7bd5797d64d · 2024-12-08T15:14:25.000+08:00
Includes a new optional parameter, `$maxLogs`, in the updater documentation to specify the maximum number of log files to maintain, defaulting to 30. 

Clarifies user instructions for handling automatic updates.
diff --git a/README.md b/README.md
@@ -78,7 +78,8 @@ To initialize the Updater class and start the update process, follow these steps
 > `$releaseExclusions` (Optional) An array of directories or files in the release to exclude from the update.<br>
 > `$clear` (Optional) Clear the downloaded file after the update has completed if set to true.<br>
 > `$dir` (Optional) Set the directory of the update. Default to current working dir.<br>
-> `$autoUpdate` (Optional) Whether or not to automatically update the project. Defaults to true.
+> `$autoUpdate` (Optional) Whether or not to automatically update the project. Defaults to true.<br>
+> `$maxLogs` (Optional) Maximum number of log file to maintain. Defaults to 30.
 
 > The exclusions array keys:
 
diff --git a/src/Updater.php b/src/Updater.php
@@ -46,9 +46,10 @@ final class Updater
      * @param bool $clear (Optional) Whether or not to clear the downloaded file. Defaults to true.
      * @param string $dir (Optional) The directory where the update will occur. Defaults to current working directory.
      * @param bool $autoUpdate (Optional) Whether or not to automatically update the project. Defaults to true.
+     * @param int $maxLogs (Optional) Maximum number of log file to maintain. Defaults to 30.
      * @return void
      */
-    public function __construct(string $username, string $repository, string $token, string $version, string|null $admin = '', string|null $mailer = '', array|null $sourceExclusions  = ['path' => [], 'filename' => []], array|null $releaseExclusions  = ['path' => [], 'filename' => []], bool $clear = true, $dir = "", $autoUpdate = true, $maxLogs = 30)
+    public function __construct(string $username, string $repository, string $token, string $version, string|null $admin = '', string|null $mailer = '', array|null $sourceExclusions  = ['path' => [], 'filename' => []], array|null $releaseExclusions  = ['path' => [], 'filename' => []], bool $clear = true, string $dir = "", bool $autoUpdate = true, int $maxLogs = 30)
     {
         if ($admin == null) {
             $this->admin = '';
