From 2a5deb0534e5a4c8d30afd9c96586898e83aee6a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Weber?= Date: Mon, 23 Aug 2021 22:13:16 +0200 Subject: [PATCH] docs: move CHANGELOG into exampleSite #33 that makes it possible to include it into the official documentation --- .grenrc.js | 3 ++- RELEASE.md | 2 +- CHANGELOG.md => exampleSite/content/basics/CHANGELOG.md | 2 -- 3 files changed, 3 insertions(+), 4 deletions(-) rename CHANGELOG.md => exampleSite/content/basics/CHANGELOG.md (99%) diff --git a/.grenrc.js b/.grenrc.js index e54898653c..9ec5e82e9b 100644 --- a/.grenrc.js +++ b/.grenrc.js @@ -1,5 +1,5 @@ module.exports = { - changelogFilename: "CHANGELOG.md", + changelogFilename: "exampleSite/content/basics/CHANGELOG.md", dataSource: "milestones", groupBy: { "Enhancements": [ @@ -30,6 +30,7 @@ module.exports = { milestoneMatch: "{{tag_name}}", onlyMilestones: true, template: { + changelogTitle: "", group: "\n### {{heading}}\n", release: ({ body, date, release }) => `## ${release} (` + date.replace( /(\d+)\/(\d+)\/(\d+)/, '$3-$2-$1' ) + `)\n${body}`, }, diff --git a/RELEASE.md b/RELEASE.md index 02e08a3257..23f799bf2a 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -27,7 +27,7 @@ We are using [gren](https://github.com/github-tools/github-release-notes) to gen - Add the changelog to git and update the tag ```shell - git add CHANGELOG.md + git add exampleSite/content/basics/CHANGELOG.md git commit --message "Ship tag " git push origin main git tag --message "" --force diff --git a/CHANGELOG.md b/exampleSite/content/basics/CHANGELOG.md similarity index 99% rename from CHANGELOG.md rename to exampleSite/content/basics/CHANGELOG.md index fc45b02017..bca793c8c3 100644 --- a/CHANGELOG.md +++ b/exampleSite/content/basics/CHANGELOG.md @@ -1,5 +1,3 @@ -# Changelog - ## 1.2.0 (2021-07-26) ### Enhancements