mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-23 15:57:57 +00:00
docs: move CHANGELOG into exampleSite #33
that makes it possible to include it into the official documentation
This commit is contained in:
parent
c31371b871
commit
2a5deb0534
3 changed files with 3 additions and 4 deletions
|
@ -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}`,
|
||||||
},
|
},
|
||||||
|
|
|
@ -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>
|
||||||
|
|
|
@ -1,5 +1,3 @@
|
||||||
# Changelog
|
|
||||||
|
|
||||||
## 1.2.0 (2021-07-26)
|
## 1.2.0 (2021-07-26)
|
||||||
|
|
||||||
### Enhancements
|
### Enhancements
|
Loading…
Reference in a new issue