什么是 Renote

Renote 是一个扩展 GitHub 操作体验的 CLI 工具，它是与 gh（GitHub 的官方命令行工具）配合使用的辅助工具。

• 通过高级搜索选项从最新版本创建问题发布说明
• 通过高级搜索选项添加或删除问题的标签
• 通过高级搜索选项将问题添加到或从里程碑中删除
• 通过高级搜索选项搜索问题

入门指南

先决条件

需要 GitHub 凭证，请参阅 如何创建个人访问令牌。

安装

您可以使用 huber 安装 renote 或直接下载发布的二进制文件。

❯ huber install renote
Updating managed repos
Updating unmanaged repos
Installing renote
Downloading package artifacts from github "https://github.com/ecatlabs/renote"
Setting renote (version: v0.1.0, source: github) as the current package
Installed executables:
 - /home/davidko/.huber/bin/renote
renote (version: v0.1.0, source: github) installed

❯ renote -V
renote v0.1.0 Commit: 261b21e-20210419081458

教程

创建发布说明配置

需要创建发布说明配置，然后更新并保存到文件，该文件将用于创建说明。

❯ renote note config
---
owner: ""
repo: ""
token: ""
state: ""
note: ~
milestone: ~
show_contributor: false
extra_contributors: ~
exclude_issues: ~
sort: ~
labels: ~
any_labels: ~
exclude_labels: ~
highlight_labels:
  - label: ""
    title: ~
    description: ~

示例

---
owner: longhorn
repo: longhorn
token: ""
state: closed        # open, closed, all
note: >-             # string or file path
  ## Release Note
  {content}

milestone: v1.1.1
show_contributor: true
extra_contributors:
  - innobead
exclude_issues:
  - 304
sort: asc            # asc, desc
labels: []
any_labels: []
exclude_labels:
  - wontfix
highlight_labels:
  - label: highlight
    title: Highlights
    description: ~

创建发布说明

根据说明配置文件，您可以搜索匹配发布范围的问题，例如里程碑、问题过滤器等。此外，说明还可以通过 Markdown 内容或文件进行自定义，其中 {content} 中的内容将被生成的说明替换。

❯ renote note create --config ./examples/note_config.yaml
...

说明配置文件中的 note 配置以扩展生成的说明。

note: >- # or file path
  ## Release Note
  {content}

搜索问题

通过高级查询搜索问题，输出可以是不同的格式（控制台、JSON、YAML）。

❯ renote issue search -o longhorn -r longhorn -q "label:kind/upstream-issue"
 Url                                                         Title 
 https://api.github.com/repos/longhorn/longhorn/issues/2106  [BUG] Recurring backup job stuck on K8s 1.19.4 if volume is attached to the same node and powered do... 
 https://api.github.com/repos/longhorn/longhorn/issues/2062  [BUG] The feature Pod Deletion Policy When Node is Down doesn't work on Kubernetes >= v1.19.0 

向问题添加标签

❯ renote issue add-label -o longhorn -r longhorn -q "label:kind/upstream-issue" --labels "kind/extra-label"
...

从问题中删除标签

❯ renote issue remove-label -o longhorn -r longhorn -q "label:kind/upstream-issue" --labels "kind/extra-label"
...

将问题移动到里程碑

❯ renote issue assign-milestone -o longhorn -r longhorn -q "label:kind/upstream-issue" next-milestone
...