Download the PHP package badabingbreda/githubupdater without Composer

On this page you can find all versions of the php package badabingbreda/githubupdater. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package githubupdater

GithubUpdater

Use this class to have your plugin check for an update on github.

Adding custom plugin headers

You can add custom headers to your plugin to make it look a little nicer. Add the following to the release notes, they will be used as values for each update setting:

Tested: 6.3
Icons: 1x|https://domainname.com/icon-256x256.png?rev=2818463,2x|https://domainname.com/icon-256x256.png?rev=2818463
Banners: 1x|https://domainname.com/banner-720x250.png
RequiresPHP: 7.0

|||
Add your changelog here

Release format

Make sure to use the correct release format to indicate that there's an update. Draft a release and add a tag in the x.y.z format. For instance:

1.0.0
1.1.0
1.21.3
2.4.9

Are all good versions.

Using the updater

First course of action is to create a release for your plugin on Github. You can draft a release, add a tag '1.0.0' and confirm.

Add the class via Composer from within your plugin's directory:

composer require badabingbreda/githubupdater

Make sure to include the autoload in your main plugin file.

// load our Composer autoload
require_once( 'vendor/autoload.php' );

In your plugin add the following:

$github_updater = new \BadabingBreda\GithubUpdater(__FILE__);
$github_updater->set_username('yourusername');
$github_updater->set_repository('repository-slug');
$github_updater->set_settings([
                    'requires' => '7.4',
                    'tested'   => '6.3',
                ]);
$github_updater->initialize();

All versions of githubupdater with dependencies

PHP Build Version
Package Version
No informations.
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package badabingbreda/githubupdater contains the following files

Loading the files please wait ....