mirror of
https://github.com/McShelby/hugo-theme-relearn
synced 2025-04-30 16:49:05 +08:00
Adjust gren configuration
to work flawlessly
This commit is contained in:
parent
146965c497
commit
00b66e90cb
25
.grenrc.yml
25
.grenrc.yml
@ -1,25 +1,22 @@
|
|||||||
---
|
---
|
||||||
dataSource: "prs"
|
dataSource: "milestones"
|
||||||
prefix: "v"
|
onlyMilestones: true
|
||||||
onlyMilestones: false
|
milestoneMatch: "{{tag_name}}"
|
||||||
changelogFilename: "CHANGELOG.md"
|
changelogFilename: "CHANGELOG.md"
|
||||||
includeMessages: "all"
|
ignore-tags-with:
|
||||||
ignoreIssuesWith:
|
- "Relearn"
|
||||||
- "support"
|
|
||||||
ignoreLabels:
|
ignoreLabels:
|
||||||
|
- "documentation"
|
||||||
- "duplicate"
|
- "duplicate"
|
||||||
- "invalid"
|
- "invalid"
|
||||||
|
- "support"
|
||||||
- "wontfix"
|
- "wontfix"
|
||||||
groupBy:
|
groupBy:
|
||||||
New features:
|
|
||||||
- "feature"
|
|
||||||
Bug Fixes:
|
Bug Fixes:
|
||||||
- "bug"
|
- "bug"
|
||||||
Enhancements:
|
New features:
|
||||||
- "enhancement"
|
- "feature"
|
||||||
Internationalisation:
|
Maintenance:
|
||||||
- "i18n"
|
- "task"
|
||||||
Theme Meta:
|
|
||||||
- "meta"
|
|
||||||
Uncategorised:
|
Uncategorised:
|
||||||
- "closed"
|
- "closed"
|
||||||
|
19
README.md
19
README.md
@ -48,11 +48,19 @@ Special thanks to [@matcornic](https://github.com/matcornic) for his work on [le
|
|||||||
|
|
||||||
## Releasing
|
## 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 <API TOKEN>` and restart your shell
|
||||||
|
|
||||||
|
Per release:
|
||||||
|
|
||||||
|
- Close all issues of the milestone or push them back to an open milestone
|
||||||
- Close the milestone
|
- Close the milestone
|
||||||
- Check merged MRs on the milestone have a tag (Bug, Enhancement, etc.)
|
|
||||||
- Tag and push the repo
|
- Tag and push the repo
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
@ -63,10 +71,9 @@ Somewhat work-in-progress steps to release with [gren](https://github.com/github
|
|||||||
- Generate CHANGELOG.md with _gren_
|
- Generate CHANGELOG.md with _gren_
|
||||||
|
|
||||||
```shell
|
```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
|
- Add the changelog to git and update the tag
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
@ -80,5 +87,5 @@ Somewhat work-in-progress steps to release with [gren](https://github.com/github
|
|||||||
- Generate release with _gren_
|
- Generate release with _gren_
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
gren release -t <tag>
|
npx github-release-notes@0.17.1 release --tags <tag>
|
||||||
```
|
```
|
||||||
|
Loading…
x
Reference in New Issue
Block a user