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

Release note gets all issues

Ouverte
#319 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
JavaScript
Étoiles
897
Forks
313
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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
```

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par la configuration .grenrc.yaml et la commande gren release dans le workflow GitHub Actions fourni. Reproduisez le comportement de la première exécution avec datasources: issues, puis comparez-le à une deuxième exécution ; c’est terminé lorsque la note de version initiale inclut uniquement les issues fermées entre le dernier et le plus récent tag.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
github-actions, javascript, node.js, yaml
Domaine
devops, release
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.