nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-27 09:43:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: move CHANGELOG into exampleSite #33

Browse source 
that makes it possible to include it into the official documentation
This commit is contained in:
Sören Weber 2021-08-23 22:13:16 +02:00
parent c31371b871
commit 2a5deb0534
No known key found for this signature in database
GPG key ID: 07D17FF580AE7589
3 changed files with 3 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
.grenrc.js
View file

@ -1,5 +1,5 @@
module.exports = { module.exports = {
changelogFilename: "CHANGELOG.md", changelogFilename: "exampleSite/content/basics/CHANGELOG.md",
dataSource: "milestones", dataSource: "milestones",
groupBy: { groupBy: {
"Enhancements": [ "Enhancements": [
@ -30,6 +30,7 @@ module.exports = {
milestoneMatch: "{{tag_name}}", milestoneMatch: "{{tag_name}}",
onlyMilestones: true, onlyMilestones: true,
template: { template: {
changelogTitle: "",
group: "\n### {{heading}}\n", group: "\n### {{heading}}\n",
release: ({ body, date, release }) => `## ${release} (` + date.replace( /(\d+)\/(\d+)\/(\d+)/, '$3-$2-$1' ) + `)\n${body}`, release: ({ body, date, release }) => `## ${release} (` + date.replace( /(\d+)\/(\d+)\/(\d+)/, '$3-$2-$1' ) + `)\n${body}`,
}, },

2
RELEASE.md
View file

@ -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 - Add the changelog to git and update the tag
```shell ```shell
git add CHANGELOG.md git add exampleSite/content/basics/CHANGELOG.md
git commit --message "Ship tag <tag>" git commit --message "Ship tag <tag>"
git push origin main git push origin main
git tag --message "" --force <tag> git tag --message "" --force <tag>

2
CHANGELOG.md → exampleSite/content/basics/CHANGELOG.md
View file

@ -1,5 +1,3 @@
# Changelog
## 1.2.0 (2021-07-26) ## 1.2.0 (2021-07-26)
### Enhancements ### Enhancements