vortechstudio/laravel-github-issues

此包针对laravel,可在代码中遇到错误、关键或紧急异常时在github上创建工单,openAI可以帮助创建工单。

v1.0.0 2024-01-29 14:18 UTC

README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

这里应该放置你的描述。请限制为一两段。考虑添加一个小的示例。

支持我们

我们投入了大量资源来创建一流的开放源代码包。您可以通过购买我们的付费产品之一来支持我们。

我们非常感谢您从家乡寄来明信片,说明您正在使用我们的哪些包。您可以在我们的联系页面找到我们的地址。我们将在我们的虚拟明信片墙上发布所有收到的明信片。

安装

您可以通过composer安装此包

composer require vortechstudio/laravel-github-issues

您可以使用以下命令发布和运行迁移

php artisan vendor:publish --tag="laravel-github-issues-migrations"
php artisan migrate

您可以使用以下命令发布配置文件

php artisan vendor:publish --tag="laravel-github-issues-config"

在.env文件中添加以下环境变量

GITHUB_TOKEN=
GITHUB_OWNER=
GITHUB_REPOSITORY=
OPENAI_STATE=true
OPENAI_API_KEY=sk-...
OPENAI_ORGANIZATION=org-...

OPENAI_STATE 用于启用或禁用创建工单时使用的 openAI API

如果您没有openAI账户,您可以在https://openai.com/免费创建一个。

创建您的账户并将您的API密钥添加到OPENAI_API_KEY变量中

在config/services.php文件中添加Github服务

    'github' => [
        "token" => env('GH_TOKEN', null),
    ],

在config/logging.php文件中添加日志系统

    'github_issues' => [
            "driver" => "monolog",
            'level' => "error",
            "handler" => \Vortechstudio\LaravelGithubIssues\GithubIssuesHandler::class,
            "channels" => ["daily"]
        ]

将.env文件中的LOG_CHANNEL设置为github_issues

使用

系统将自动检测错误或更高级别的错误,并在github上创建工单。

测试

composer test

变更日志

有关最近更改的更多信息,请参阅CHANGELOG

贡献

有关详细信息,请参阅CONTRIBUTING

安全漏洞

有关如何报告安全漏洞,请参阅我们的安全策略

鸣谢

许可证

MIT许可证(MIT)。有关更多信息,请参阅许可证文件