Download the PHP package koderzi/php-github-updater without Composer
On this page you can find all versions of the php package koderzi/php-github-updater. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
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 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.
Informations about the package php-github-updater
GitHub Release Updater
The GitHub Release Updater is a PHP class that enables you to update your project from the latest GitHub repository releases. The class is simple to use and highly efficient in keeping your project up-to-date with the latest releases.
Preparation
Before using this class, you need to generate a personal access token on GitHub. Follow these steps:
- Go to https://github.com/settings/tokens/new
- Select the repository and enable read-only access for Contents and Metadata.
- Click on "Generate token" and copy the token.
Installation
To use this class with Composer, follow these steps:
- Open a terminal or command prompt in your project's root directory.
-
Run the following command to initialize a composer.json file in your project:
- Follow the prompts to fill out the details for your project (e.g. package name, description, author, etc.).
- Run the following command to install the koderzi/php-github-updater package:
This will download the package and its dependencies and add them to your vendor directory.
- Include the vendor/autoload.php file in your project's to autoload the class provided by the package:
If you're using a framework or other autoloading mechanism, you may need to include this file manually.
To use this class with direct download, follow these steps:
- Retrieve the Updater.php file from the src directory in the repository.
- Put the Updater.php file in your project's directory.
- include the file to your project's to load the class.
Usage
To initialize the Updater class and start the update process, follow these steps:
- Instantiate the class with the following parameters:
$usernameYour GitHub username.
$repositoryThe name of your GitHub repository.
$tokenThe personal access token you generated earlier.
$versionThe current version number of your project.
$admin(Optional) The email address of the admin who will receive an email in case of update failure.
$mailer(Optional) The email address that the email will be sent from.
$sourceExclusions(Optional) An array of directories or files in the source to be exclude from the update.
$releaseExclusions(Optional) An array of directories or files in the release to exclude from the update.
$clear(Optional) Clear the downloaded file after the update has completed if set to true.
$dir(Optional) Set the directory of the update. Default to current working dir.
$autoUpdate(Optional) Whether or not to automatically update the project. Defaults to true.
$maxLogs(Optional) Maximum number of log file to maintain. Defaults to 30.The exclusions array keys:
To check the release version, use the following code:
If a new release is available, the class will update your project automatically. To update manually, set $autoUpdate to false and use the following code to start update:
To check the status of the update, use the following code:
The update status can have the following int values:
Updater::INIT(100): Indicates that update class has been initialized.
Updater::UPDATED(200): Indicates that the update was successful.
Updater::LATEST(204): Indicates that the project is already up to date.
Updater::ERROR(500): Indicates that the update failed.
Updater::BUSY(504): Indicates that an update process is in progress.
Conclusion
The GitHub Release Updater is a simple and efficient way to keep your project up-to-date with the latest releases on GitHub. It is easy to use and can save you a lot of time and effort. If you have any questions or issues, please feel free create an issue.
