Skip to content

Install specific Cachetool version #4161

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.

Sign up for GitHub

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

Open
alexander-nitsche-governikus wants to merge 2 commits into
base: master
Choose a base branch
from
+37 −33
Open

Install specific Cachetool version #4161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be99cd4
Install specific Cachetool version
alexander-nitsche-governikus Feb 3, 2026
25e37f0
Use verbose variable inline-notation of Deployer
alexander-nitsche-governikus Feb 3, 2026
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
32 changes: 21 additions & 11 deletions contrib/cachetool.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,21 +49,31 @@
namespace Deployer;

set('cachetool', '');
/**
* URL to download cachetool from if it is not available
*
* CacheTool 9.x works with PHP >=8.1
* CacheTool 8.x works with PHP >=8.0
* CacheTool 7.x works with PHP >=7.3
*/
set('cachetool_url', 'https://github.com/gordalina/cachetool/releases/download/9.1.0/cachetool.phar');
set('cachetool_args', '');
set('cachetool_version', null);

// Returns Cachetool binary path if found. Otherwise, tries to install Cachetool to `.dep/cachetool.phar`.
set('bin/cachetool', function () {
if (!test('[ -f {{release_or_current_path}}/cachetool.phar ]')) {
run("cd {{release_or_current_path}} && curl -sLO {{cachetool_url}}");
if (test('[ -f {{deploy_path}}/.dep/cachetool.phar ]')) {
if (empty(get('cachetool_version')) || preg_match(parse('/Cachetool.*{{cachetool_version}}/'), run('{{bin/php}} {{deploy_path}}/.dep/cachetool.phar --version'))) {
return '{{bin/php}} {{deploy_path}}/.dep/cachetool.phar';
}
}
return '{{release_or_current_path}}/cachetool.phar';

if (has('cachetool_url')) {
warning('The option "cachetool_url" is outdated, use "cachetool_version" instead.');
}

$urlLatest = 'https://github.com/gordalina/cachetool/releases/latest/download/cachetool.phar';
$urlVersion = 'https://github.com/gordalina/cachetool/releases/download/{{cachetool_version}}/cachetool.phar';
$url = get('cachetool_version') ? parse($urlVersion) : (has('cachetool_url') ? get('cachetool_url') : $urlLatest);
$versionAsName = get('cachetool_version') ? ' {{cachetool_version}}' : '';
warning("Cachetool{$versionAsName} wasn't found. Installing to \"{{deploy_path}}/.dep/cachetool.phar\".");
run("cd {{deploy_path}} && curl -sSL $url -o cachetool.phar");
run('mv {{deploy_path}}/cachetool.phar {{deploy_path}}/.dep/cachetool.phar');
return '{{bin/php}} {{deploy_path}}/.dep/cachetool.phar';
});

set('cachetool_options', function () {
$options = (array) get('cachetool');
$fullOptions = (string) get('cachetool_args');
Expand Down
38 changes: 16 additions & 22 deletions docs/contrib/cachetool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,42 +85,36 @@ http://gordalina.github.io/cachetool/



### cachetool_url
[Source](https://github.com/deployphp/deployer/blob/master/contrib/cachetool.php#L59)
### cachetool_args
[Source](https://github.com/deployphp/deployer/blob/master/contrib/cachetool.php#L52)

URL to download cachetool from if it is not available

CacheTool 9.x works with PHP >=8.1
CacheTool 8.x works with PHP >=8.0
CacheTool 7.x works with PHP >=7.3

```php title="Default value"
'https://github.com/gordalina/cachetool/releases/download/9.1.0/cachetool.phar'
```


### cachetool_args
[Source](https://github.com/deployphp/deployer/blob/master/contrib/cachetool.php#L60)
### cachetool_version
[Source](https://github.com/deployphp/deployer/blob/master/contrib/cachetool.php#L53)



```php title="Default value"
null
```


### bin/cachetool
[Source](https://github.com/deployphp/deployer/blob/master/contrib/cachetool.php#L61)
[Source](https://github.com/deployphp/deployer/blob/master/contrib/cachetool.php#L56)

Returns Cachetool binary path if found. Otherwise, tries to install Cachetool to `.dep/cachetool.phar`.
:::info Autogenerated
The value of this configuration is autogenerated on access.
:::


```php title="Default value"
if (!test('[ -f {{release_or_current_path}}/cachetool.phar ]')) {
run("cd {{release_or_current_path}} && curl -sLO {{cachetool_url}}");
}
return '{{release_or_current_path}}/cachetool.phar';
```


### cachetool_options
[Source](https://github.com/deployphp/deployer/blob/master/contrib/cachetool.php#L67)
[Source](https://github.com/deployphp/deployer/blob/master/contrib/cachetool.php#L77)


:::info Autogenerated
Expand All @@ -134,23 +128,23 @@ The value of this configuration is autogenerated on access.
## Tasks

### cachetool\:clear\:opcache {#cachetool-clear-opcache}
[Source](https://github.com/deployphp/deployer/blob/master/contrib/cachetool.php#L89)
[Source](https://github.com/deployphp/deployer/blob/master/contrib/cachetool.php#L99)

Clears OPcode cache.

Clear opcache cache


### cachetool\:clear\:apcu {#cachetool-clear-apcu}
[Source](https://github.com/deployphp/deployer/blob/master/contrib/cachetool.php#L100)
[Source](https://github.com/deployphp/deployer/blob/master/contrib/cachetool.php#L110)

Clears APCu system cache.

Clear APCu cache


### cachetool\:clear\:stat {#cachetool-clear-stat}
[Source](https://github.com/deployphp/deployer/blob/master/contrib/cachetool.php#L111)
[Source](https://github.com/deployphp/deployer/blob/master/contrib/cachetool.php#L121)

Clears file status and realpath caches.

Expand Down