github-tools / github-tools/github-release-notes
Release note gets all issues
- Lenguaje dominante
- JavaScript
- Estrellas
- 897
- Forks
- 313
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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
```
Guía de contribución
Línea de trabajo
Comienza con la configuración .grenrc.yaml y el comando gren release del workflow de GitHub Actions proporcionado. Reproduce el comportamiento de la primera ejecución con datasources: issues y compáralo con una segunda ejecución; se considera terminado cuando la nota de la versión inicial incluye únicamente los issues cerrados entre el último y el más reciente tag.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- github-actions, javascript, node.js, yaml
- Área
- devops, release
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100