Laravel Zero Self Update

https://github.com/jeffersongoncalves/laravel-zero-self-update
Admin
Laravel Zero Self Update provides a reusable self-update service and base command for Laravel Zero...
Tokens:1,317
Snippets:11
Trust Score:9.8
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install laravel-zero-self-update via Composer

Source: https://github.com/jeffersongoncalves/laravel-zero-self-update/blob/main/README.md

Installs the package. Requires PHP ^8.2, guzzlehttp/guzzle ^7.10, and illuminate/console ^11|^12.

```bash
composer require jeffersongoncalves/laravel-zero-self-update
```

--------------------------------

### Create a self-update command extending SelfUpdateCommand

Source: https://github.com/jeffersongoncalves/laravel-zero-self-update/blob/main/README.md

Extend the base SelfUpdateCommand and implement the four abstract methods: githubRepo(), assetName(), tempPrefix(), and currentVersion(). Override currentVersion() to read your app version from config.

```php
<?php

namespace App\Commands;

use JeffersonGoncalves\LaravelZero\SelfUpdate\SelfUpdateCommand as BaseSelfUpdateCommand;

class SelfUpdateCommand extends BaseSelfUpdateCommand
{
    protected function githubRepo(): string
    {
        return 'jeffersongoncalves/git-worktree-cli';
    }

    protected function assetName(): string
    {
        return 'git-worktree.phar';
    }

    protected function tempPrefix(): string
    {
        return 'git_worktree_';
    }

    protected function currentVersion(): string
    {
        return config('app.version', 'unreleased');
    }
}
```

--------------------------------

### Run tests with composer test

Source: https://github.com/jeffersongoncalves/laravel-zero-self-update/blob/main/README.md

Runs the test suite for the package.

```bash
composer test
```

--------------------------------

### Run self-update command with --check flag

Source: https://github.com/jeffersongoncalves/laravel-zero-self-update/blob/main/README.md

Run the self-update command. Use --check to only report whether an update is available. Self-update only runs when the app is executed as a PHAR; otherwise it tells the user to update via Git or Composer.

```bash
my-cli self-update          # download and install the latest release
my-cli self-update --check  # only report whether an update is available
```

--------------------------------

### Use PharUpdater service directly

Source: https://github.com/jeffersongoncalves/laravel-zero-self-update/blob/main/README.md

Use PharUpdater directly to check for updates, download the latest release, and replace the PHAR. A custom Guzzle Client can be injected as the last constructor argument for testing or proxies.

```php
use JeffersonGoncalves\LaravelZero\SelfUpdate\PharUpdater;

$updater = new PharUpdater(
    githubRepo: 'jeffersongoncalves/git-worktree-cli',
    assetName: 'git-worktree.phar',
    tempPrefix: 'git_worktree_',
    currentVersion: config('app.version', 'unreleased'),
);

$release = $updater->getLatestRelease(); // ['tag' => 'v1.2.0', 'url' => '...']

if ($updater->isUpdateAvailable($updater->getCurrentVersion(), $release['tag'])) {
    $tempFile = $updater->download($release['url']);
    $updater->replacePhar($tempFile);
}
```
Tokens:
Raw