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

Release note gets all issues

Aberta
#319 0 comentários 0 reações 0 responsáveis Ver no GitHub
Linguagem predominante
JavaScript
Estrelas
897
Forks
313
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

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

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

Start with the .grenrc.yaml configuration and the gren release command in the provided GitHub Actions workflow. Reproduce the first-run behavior with datasources: issues, then compare it with a second run; done means the initial release note includes only issues closed between the last and latest tags.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
github-actions, javascript, node.js, yaml
Domínio
devops, release
Tipo de issue
Bug
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.