docs: up website & sh

This commit is contained in:
元凛
2022-02-09 17:24:35 +08:00
parent f6cad1ea63
commit 1a0a9f0bf6
41 changed files with 1340 additions and 2278 deletions

View File

@@ -26,10 +26,62 @@ GitHub Actions 是由 GitHub 免费提供的。其中 `Private` 项目每月有
你可以查看详细的 [更新日志](/changelog)。推荐采用最新 releases 版本。
- 版本规则
- 采用两级语义化版本如v1、v1.1、v2、v2.1
- v1 表示初始版本
- 对 v1 版本的修复和新增会发布到 v1.1 版本
- 当发布的 v1.x 运行一定时间稳定或进行重构时,发布进阶 v2.x 版本
- v2 版本后会严格按照三级语义来发布版本,如 v2.0.0、v2.1.0
- 版本选择
- 建议采用最新 releases 版本。可在 [releases](https://github.com/actions-cool/issues-helper/releases) 看到
- 同时也可参照下面的更新日志来选择版本
- 最新的 v1.x release 代码会合并到 1.x 分支中
- v2 版本后支持使用 v2 tag将同步最新 2.x 代码
- 支持直接使用分支版本。如:
```yml
- name: Issues Helper
uses: actions-cool/issues-helper@main
# or
- name: Issues Helper
uses: actions-cool/issues-helper@1.x
# or
- name: Issues Helper
uses: actions-cool/issues-helper@v3
```
## 从 v1.x 升级到 v2有什么注意的地方吗
v1.12 和 v2.0.0 版本的差别只有一处。即 `mark-duplicate` 中的 `require-permission` 增加了默认值 `write`
## v3 变更
🚀 v3 版本重构完成,主要变更内容:
1. JS to TS
2. 将 issue 核心功能封装成为类供 helper 使用
3. 提示信息统一
4. 增加自动发布脚本
功能变更参考:
- 🚀 New Feature
- `mark-assignees`: 评论快捷设置 assignees
- `find-issues`: 条件查询当前仓库 issues
- 🐞 Bug Fix
- 修复 `find-comments` 返回结果 direction 未起作用
- 修复 `lock-issues` lock 与 comment 的顺序问题
- 🛠 Refactor
- contents 更名为容易理解的 emoji
- deleteComment updateComment 不再支持 `out-comments`,保持纯粹功能
- 移除 title body 默认值
- `month-statistics` 移除,可使用 [issues-month-statistics](https://github.com/actions-cool/issues-month-statistics)
## 如果这里没有我想要的功能,该怎么办?
你可以在 [What do you want?](https://github.com/actions-cool/issues-helper/discussions/18) 中提出。
你可以在 issues 中提出。