Versioncheck for Plugins

Khepri.Design · January 13, 2023, 7:03pm

Hi there,

i have a plugin / template, which is accessable via composer, but the versioncheck in the backend is not working.
update

Does the plugin have to be published to kirby for that?

greetings
Timo Haas

texnixe · January 13, 2023, 7:14pm

What is your Kirby version? What do you mean it is not working? What is this 3.8.8.1 version shown?

Khepri.Design · January 13, 2023, 7:48pm

Hi,

my kirby version is 3.8.4. The 3.8.8.1 is the version of the plugin on packagist and was installed via composer.
Now i wonder, why it doesnt recognize that 3.8.8.1 is the newest version.

greetings

distantnative · January 14, 2023, 11:55am

Which plugin is it?

rasteiner · January 14, 2023, 12:45pm

Here’s a list of all kirby plugins published to packagist with their versions. I can’t find any 3.8.8.1

Khepri.Design · January 14, 2023, 2:30pm

Thanks, pretty cool tool though!
The plugin is available via composer: khepri-design/khepri-base - Packagist
Do i have to define anywhere that this is for kirby or smth like that? I don’t want to publish it via Plugins | Kirby CMS yet, but want my customers to update via the panel.

I hope i explained it well, its the first time, i “publish” a plugin.

texnixe · January 14, 2023, 2:49pm

Kirby gets the version number either from the composer.json file or from vendor/composer/installed.php:

// if plugin doesn’t have version key in composer.json file
// try to get version from “vendor/composer/installed.php”

rasteiner · January 14, 2023, 3:02pm

Yes, Kirby plugins need to have a "type": "kirby-plugin" property in their composer.json file. I think this is for the custom composer installer (you also need to require) so that the plugin gets installed into site/plugins/ and not into vendor/.

See an example here:

PS:

I don’t know if users can update via panel. AFAIK the panel only tells you if there is an update, it doesn’t give you an option to actually install it.

Khepri.Design · January 14, 2023, 5:15pm

Hi, thanks i missed the “type” somehow.

okey i didnt know that this is just an information, thanks for the advice

moritzebeling · February 20, 2023, 9:49am

In the »Basic Plugin Setup« article (link above), it says the version has to be included in composer.json in order for Kirby to check if the plugin is up to date.

However if I put the version number in my plugin, it still shows “Could not check for updates”. (Yes the plugin is live on GitHub and Packagist and installed via Composer. And yes, everywhere including Kirby Panel it says the version is 1.0.0)

And some other plugin I have installed, doesn’t have a version number in their composer.json, but in the panel it shows “Plugin is up to date”.

I would love to see a green checkmark for my plugins… but how can I tell Kirby that the plugin is up to date? Thanks for any ideas!

rasteiner · February 20, 2023, 12:11pm

I think you need to have it listed on Plugins | Kirby CMS

bnomei · February 20, 2023, 12:26pm

the system queries an update status from a file hosted by getkirby.com
https://assets.getkirby.com/plugins.json

github.com

getkirby/kirby/blob/617a07aa0151aa4b1a3735b3b5e1a41ccc244a43/src/Cms/System/UpdateStatus.php#L507


      
          		}
          
          
		// first catch every exception;
          		// we collect it below for debugging
          		try {
          			if (static::$timedOut === true) {
          				throw new Exception('Previous remote request timed out'); // @codeCoverageIgnore
          			}
          
          
			$response = Remote::get(
          				static::$host . '/' . $key . '.json',
          				['timeout' => 2]
          			);
          
          
			// allow status code HTTP 200 or 0 (e.g. for the file:// protocol)
          			if (in_array($response->code(), [0, 200], true) !== true) {
          				throw new Exception('HTTP error ' . $response->code()); // @codeCoverageIgnore
          			}
          
          
			$data = $response->json();

for a single plugin with package name (thats the one from the composer package)

github.com

getkirby/kirby/blob/617a07aa0151aa4b1a3735b3b5e1a41ccc244a43/src/Cms/System/UpdateStatus.php#L67


      
          	public function __construct(
          		App|Plugin $package,
          		bool $securityOnly = false,
          		array|null $data = null
          	) {
          		if ($package instanceof App) {
          			$this->app        = $package;
          			$this->pluginName = null;
          		} else {
          			$this->app        = $package->kirby();
          			$this->pluginName = $package->name();
          		}
          
          
		$this->securityOnly   = $securityOnly;
          		$this->currentVersion = $package->version();
          
          
		$this->data = $data ?? $this->loadData();
          	}
          
          
	/**
          	 * Returns the currently installed version

example: https://assets.getkirby.com/plugins/bnomei/janitor.json

but like @rasteiner said it will only list packages it know of so you need to register them at getkirby.com via a PR to GitHub - getkirby/getkirby.com: Source code and content for the Kirby website

Topic		Replies	Views
Get Plugin Version from composer.json value Solved ✔️ plugin	2	183	January 3, 2024
Upgrade (really) old Kirby website to latest version	3	81	October 27, 2024
Kirby Version Widget Plugins	8	2076	August 29, 2016
What more can you do to display correct version information in the system panel Solved ✅ panel	3	275	March 25, 2023
Installing Plugins with Composer	3	285	October 12, 2022

Versioncheck for Plugins

Related topics