README

安装

$ composer require jiannei/easy-github -vvv

使用方法

测试准备

• 在 web 服务器创建 test 目录和测试使用的 index.php 文件

// xxx/xxx/test/index.php
require __DIR__.'/vendor/autoload.php';

use Jiannei\EasyGithub\GithubClient;

$githubClient = new GithubClient();

授权测试参考流程

• 设置 -> Oauth 应用 -> 授权回调 URL 配置本地测试地址
• 访问 https://github.com/login/oauth/authorize?client_id=YOUR_OAUTH_APP_CLIENT_ID
• 将以下测试代码添加到测试文件，访问 index.php，将得到授权成功返回的 access_token

if (isset($_GET['code'])) {
    $response = $githubClient->api('oauthApps')->getAccessToken([
        'client_id'     => 'YOUR_OAUTH_APP_CLINET_ID',
        'client_secret' => 'YOUR_OAUTH_APP_CLINET_SECRET',
        'code'          => $_GET['code'],
    ]);
    var_export($response->body());
}else{
    echo '<br />testing...';
}

Github Action Secrets

• 获取 public_key

// 需要事先获取到授权 $accessToken
$response = $githubClient->api('secrets')->authorize($accessToken)->publicKey("Jiannei","vuepress-blog-demo");

• 获取全部的 secret

// 需要事先获取到授权 $accessToken
$response = $githubClient->api('secrets')->authorize($accessToken)->all("Jiannei","vuepress-blog-demo");

• 获取指定的 secret

// 需要事先获取到授权 $accessToken
$response = $githubClient->api('secrets')->authorize($accessToken)->show("Jiannei","vuepress-blog-demo",'ACCESS_TOKEN');

• 创建或更新 secret

// 需要事先获取到授权 $accessToken + 获取 public_key
$keypair = [
    'key_id' => 'your key_id',// 调用获取 public_key 接口得到的 key_id
    'key' => 'your key',// 调用获取 public_key 接口得到的 key
];

$params = [
    'value' => 'hello,world',// 新增/更新的 secret 值
    'name' => 'TEST'// secret 名称
];

// $response = $githubClient->api('secrets')->authorize($accessToken)->store("Jiannei", "vuepress-blog-demo", $keypair, $params);

• 删除 secret（测试未通过)

// 需要事先获取到授权 $accessToken
$response = $githubClient->api('secrets')->authorize($accessToken)->destroy("Jiannei","vuepress-blog-demo",'TEST');

Laravel 相关

贡献

您可以通过以下三种方式之一进行贡献

1. 使用 问题跟踪器 提交错误报告。
2. 在 问题跟踪器 上回答问题或修复错误。
3. 贡献新功能或更新 wiki。

代码贡献流程并不十分正式。您只需确保遵循 PSR-0、PSR-1 和 PSR-2 编码指南。任何新的代码贡献都必须伴随着适用的单元测试。

许可证

MIT