Download the PHP package potherca/flysystem-github without Composer
On this page you can find all versions of the php package potherca/flysystem-github. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download potherca/flysystem-github
More information about potherca/flysystem-github
Files in potherca/flysystem-github
Package flysystem-github
Short Description Flysystem adapter for Github
License MIT
Homepage https://github.com/potherca/flysystem-github
Informations about the package flysystem-github
Flysystem Adapter for Github
Install
Via Composer
Usage
The Github adapter can be used without credentials to do read-only actions on public repositories. To avoid reaching the Github API limit, to save changes, or to read from private repositories, credentials are required.
Caching can be utilized to save traffic or to postpone reaching the Github API limit.
Basic Usage
Authentication
Cache Usage
Testing
The unit-tests can be run with the following command:
To run integration tests, which use the Github API, a Github API token might be needed (to stop the tests hitting the API Limit).
An API key can be added by setting it in the environment as GITHUB_API_KEY
or by creating an .env
file in the integration tests directory and setting it there.
See tests/integration-tests/.env.example
for an example.
To run the integration test, run the following command (this will also run the unit-tests):
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Contributing
Please see CONTRIBUTING for details.
Change Log
Please see CHANGELOG for details.
Credits
License
The MIT License (MIT). Please see License File for more information.