OctoberCMS GitHub Projects Plugin
![Build Status][ico-travis]
![StyleCI][ico-style]
![Code Coverage][ico-code-coverage], (*1)
A plugin which utilizes to GitHub API to show informations about repositories., (*2)
Details
This plugin will provide a collection of components to display data about GitHub repositories based on the GitHub API v3., (*3)
As time passes more parts like Projects or Issues will be added to this collection of components., (*4)
Requirements
In order to work the PHP cURL extension must be installed and enabled., (*5)
Documentation
RepoList
List public repositories for the specified user., (*6)
Parameters
| Name |
Type |
Description |
user |
string |
The user whose repositories are displayed |
type |
string |
The repository type. Can be one of all, owner, member. Default: owner
|
sort |
string |
The sorting field. Can be one of created, updated, pushed, full_name. Default: full_name
|
direction |
string |
The sort direction. Can be one of asc or desc. Default: when using full_name: asc, otherwise desc
|
Item
Get a specific repository, (*7)
The available variables which can be used in the component view are listed here: https://developer.github.com/v3/repos/#response-3, (*8)
Parameters
| Name |
Type |
Description |
user |
string |
The user whose repository is displayed |
repo |
string |
The repository name |
Gist
Get a specific repository, (*9)
The available variables which can be used in the component view are listed here: https://developer.github.com/v3/gists/#get-a-single-gist, (*10)
Parameters
| Name |
Type |
Description |
id |
string |
ID of the gist |
| sha | string | Get a specific revision of a gist |
Contributing
Please submit pull requests with translations or bugfixes on the plugin's GitHub page. Bug reports and feature requests via Issues are welcome!, (*11)
Security
If you discover any security related issues, please email security@pascalkleindienst.de instead of using the issue tracker., (*12)
Credits
License
The MIT License (MIT). Please see License File for more information., (*13)