github-tools / github-tools/github-release-notes
Release note gets all issues
- Ngôn ngữ chính
- JavaScript
- Star
- 897
- Fork
- 313
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
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
```
Hướng dẫn đóng góp
Hướng nghiên cứu
Bắt đầu với cấu hình .grenrc.yaml và lệnh gren release trong GitHub Actions workflow được cung cấp. Tái hiện hành vi của lần chạy đầu tiên với datasources: issues, sau đó so sánh với lần chạy thứ hai; được xem là hoàn tất khi ghi chú phát hành ban đầu chỉ bao gồm các issue được đóng giữa tag cuối cùng và tag mới nhất.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- github-actions, javascript, node.js, yaml
- Lĩnh vực
- devops, release
- Loại issue
- Lỗi
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100