iqnection/silverstripe-bugherd

集成BugHerd与SilverStripe CMS

安装: 1

依赖项: 0

建议者: 0

安全性: 0

星星: 0

关注者: 4

分支: 0

开放问题: 0

类型:silverstripe-vendormodule

0.0.1 2021-01-05 13:52 UTC

This package is auto-updated.

Last update: 2024-09-06 02:35:44 UTC


README

将SilverStripe CMS与BugHerd任务集成

[仍在开发中]

安装

composer require iqnection/silverstripe-bugherd

获取您的API密钥和项目ID

API密钥

  • 登录BugHerd,编辑您的个人资料
  • 选择项目设置的组织
  • 在“常规”选项卡上,您将看到您的“认证令牌”

项目ID

在您的根目录.env文件中,添加以下API凭据

BUGHERD_ENABLED="true"
BUGHERD_API_KEY="my-bugherd-api-key"
BUGHERD_PROJECT_ID="my-bugherd-project-id"

设置

创建webhook以接收新/更改/删除任务的更新 打开SSH终端并连接到您的服务器,使用以下命令运行任务... /path/to/site/root/vendor/bin/sake dev/tasks/bugherd task={bugherd-task} [extraParam=value]

以下命令任务可用

下载任务

为了避免下载所有任务,您可以在SilverStripe中包含可选的{status}参数来根据任务状态进行过滤 /path/to/site/root/vendor/bin/sake dev/tasks/bugherd task=getTasks 可选参数

  • status: 根据状态过滤 在任务最初下载后,您需要运行更新。在批量下载任务时,不会提供所有数据。

更新任务

更新任务数据,逐个 /path/to/site/root/vendor/bin/sake dev/tasks/bugherd task=updateTasks 可选参数

  • status: 根据状态过滤,用逗号分隔多个值

更新同步任务的状态

仅更新任务的状态 /path/to/site/root/vendor/bin/sake dev/tasks/bugherd task=updateStatuses 可选参数

  • status: 根据状态过滤,用逗号分隔多个值

创建Webhooks

创建三个webhook以接收任务创建、更新和删除时的更新 /path/to/site/root/vendor/bin/sake dev/tasks/bugherd task=createWebhooks

您可以通过更新类状态来禁用某些钩子

IQnection\BugHerd\BugHerdTasks:
  events:
    task_update: false

删除Webhooks

/path/to/site/root/vendor/bin/sake dev/tasks/bugherd task=deleteWebhooks

如何使用

当启用时,所有页面都将获得一个BugHerd选项卡,用于跟踪特定页面的问题。

将提供额外的报告,以按页面查看任务,这使得对具有多个任务的页面进行分组变得更容易。