diff --git a/README.md b/README.md index 44e99db71b..c32159d1af 100644 --- a/README.md +++ b/README.md @@ -36,56 +36,16 @@ Check that your Hugo version is minimum `0.25` with `hugo version`. - [Visit the documentation](https://relearn.netlify.app/) +## Changelog + +[The changelog can be seen here.](https://github.com/McShelby/hugo-theme-relearn/blob/main/CHANGELOG.md) + ## License -[MIT licensed.](https://en.wikipedia.org/wiki/MIT_License) +[MIT licensed.](https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE) ## Credits Many thanks to [everyone who has contributed](https://github.com/McShelby/hugo-theme-relearn/graphs/contributors) to this project. Special thanks to [@matcornic](https://github.com/matcornic) for his work on [learn](https://github.com/matcornic/hugo-theme-learn) and [@vjeantet](https://github.com/vjeantet) for his work on [docdock](https://github.com/vjeantet/hugo-theme-docdock), which hugo-theme-relearn is based on. - -## Releasing - -We are using [gren](https://github.com/github-tools/github-release-notes) to generate the changelog and releasenotes automatically. - -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 -- Tag and push the repo - - ```shell - git tag - git push origin - ``` - -- Generate CHANGELOG.md with _gren_ - - ```shell - npx github-release-notes@0.17.1 changelog --tags=all --generate --override - ``` - -- Add the changelog to git and update the tag - - ```shell - git add CHANGELOG.md - git commit -m "Ship tag " - git push origin main - git tag -f - git push --force origin - ``` - -- Generate release with _gren_ - - ```shell - npx github-release-notes@0.17.1 release --tags - ``` diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000000..02e08a3257 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,41 @@ +# Releasing + +We are using [gren](https://github.com/github-tools/github-release-notes) to generate the changelog and release notes automatically. + +## Once: + +- Generate API Token as described in [gren's 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 +- Tag and push the repo + + ```shell + git tag --message "" + git push origin + ``` + +- Regenerate CHANGELOG.md with _gren_ + + ```shell + npx github-release-notes changelog --generate --override --tags=all + ``` + +- Add the changelog to git and update the tag + + ```shell + git add CHANGELOG.md + git commit --message "Ship tag " + git push origin main + git tag --message "" --force + git push --force origin + ``` + +- Generate release with _gren_ + + ```shell + npx github-release-notes release --tags + ```