github-tools / github-tools/github-release-notes
Release note gets all issues
- Vorherrschende Sprache
- JavaScript
- Sterne
- 897
- Forks
- 313
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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
```
Beitragsleitfaden
Rechercherichtung
Beginne mit der .grenrc.yaml-Konfiguration und dem gren release-Befehl im bereitgestellten GitHub Actions-Workflow. Reproduziere das Verhalten beim ersten Lauf mit datasources: issues und vergleiche es dann mit einem zweiten Lauf; als erledigt gilt es, wenn die anfängliche Release-Notiz nur Issues enthält, die zwischen dem letzten und dem neuesten Tag geschlossen wurden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- github-actions, javascript, node.js, yaml
- Bereich
- devops, release
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100