github-tools / github-tools/github-release-notes

Release note gets all issues

未關閉
#319 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
主要語言
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

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。