From 00b66e90cbca5bd215b19d20a9d3c12458732fb7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Weber?= Date: Thu, 1 Jul 2021 20:26:24 +0200 Subject: [PATCH] Adjust gren configuration to work flawlessly --- .grenrc.yml | 25 +++++++++++-------------- README.md | 19 +++++++++++++------ 2 files changed, 24 insertions(+), 20 deletions(-) diff --git a/.grenrc.yml b/.grenrc.yml index ad31ac8171..6abad99ed4 100644 --- a/.grenrc.yml +++ b/.grenrc.yml @@ -1,25 +1,22 @@ --- - dataSource: "prs" - prefix: "v" - onlyMilestones: false + dataSource: "milestones" + onlyMilestones: true + milestoneMatch: "{{tag_name}}" changelogFilename: "CHANGELOG.md" - includeMessages: "all" - ignoreIssuesWith: - - "support" + ignore-tags-with: + - "Relearn" ignoreLabels: + - "documentation" - "duplicate" - "invalid" + - "support" - "wontfix" groupBy: - New features: - - "feature" Bug Fixes: - "bug" - Enhancements: - - "enhancement" - Internationalisation: - - "i18n" - Theme Meta: - - "meta" + New features: + - "feature" + Maintenance: + - "task" Uncategorised: - "closed" diff --git a/README.md b/README.md index 2d83c4cfe3..44e99db71b 100644 --- a/README.md +++ b/README.md @@ -48,11 +48,19 @@ Special thanks to [@matcornic](https://github.com/matcornic) for his work on [le ## Releasing -Somewhat work-in-progress steps to release with [gren](https://github.com/github-tools/github-release-notes) +We are using [gren](https://github.com/github-tools/github-release-notes) to generate the changelog and releasenotes automatically. -- Check all MRs assigned to the milestone are closed or pushed back to another release +In the latest gren release (0.17.3) is a bug in the date generation. Therefore we are using a historical but correct version directly thru `npx`. + +Once: + +- Generate API Token as described in grens [README.md](https://github.com/github-tools/github-release-notes) +- On Windows do `setx GREN_GITHUB_TOKEN ` and restart your shell + +Per release: + +- Close all issues of the milestone or push them back to an open milestone - Close the milestone -- Check merged MRs on the milestone have a tag (Bug, Enhancement, etc.) - Tag and push the repo ```shell @@ -63,10 +71,9 @@ Somewhat work-in-progress steps to release with [gren](https://github.com/github - Generate CHANGELOG.md with _gren_ ```shell - gren changelog --override --generate --tags=all + npx github-release-notes@0.17.1 changelog --tags=all --generate --override ``` -- Fix the date for the current release in CHANGELOG.md - Add the changelog to git and update the tag ```shell @@ -80,5 +87,5 @@ Somewhat work-in-progress steps to release with [gren](https://github.com/github - Generate release with _gren_ ```shell - gren release -t + npx github-release-notes@0.17.1 release --tags ```