github-tools / github-tools/github-release-notes
Release note gets all issues
- 主要语言
- JavaScript
- 星标
- 897
- 派生
- 313
- PR 合并指标
- 30 天内没有已合并 PR
描述
With `datasources=issues` and the following GItHub Actions workflow, a Release Note has all issues with no error.
Then, run the workflow again, the Release Note gets expected issues, that have closed between the last tag and the latest tag.
```yaml
name: Release
on:
push:
tags:
- "*"
jobs:
note:
name: Release
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3.5.3
with:
fetch-depth: 0
- name: Use Node.js
uses: actions/setup-node@v3.8.0
- name: Install gren
run: |
npm install github-release-notes -g
- name: Create a release
env:
GREN_GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
run: |
gren release \
--override \
--tags=${{ github.ref_name }}
```
`.grenrc.yaml` is here.
```yaml
---
dataSource: "issues"
groupBy:
"✨ Enhancement":
- "enhancement"
"🐛 Bug":
- "bug"
changelogFilename: "CHANGELOG.md"
template:
label: ""
limit: 99
```
贡献指南
调研方向
从提供的 GitHub Actions 工作流中的 .grenrc.yaml 配置和 gren release 命令开始。使用 datasources: issues 重现首次运行的行为,然后将其与第二次运行进行比较;完成的标准是,初始发布说明仅包含在上一个 tag 和最新 tag 之间关闭的 issues。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- github-actions, javascript, node.js, yaml
- 领域
- devops, release
- Issue 类型
- 缺陷
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100