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

theme: tweak README

Browse source 
link changelog
outsource release instructions
This commit is contained in:
Sören Weber 2021-08-22 13:31:52 +02:00
parent 2aaa6fe69b
commit 4e93b3a5fe
No known key found for this signature in database
GPG key ID: 07D17FF580AE7589
2 changed files with 46 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
README.md
View file

@ -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 <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
- Tag and push the repo
```shell
git tag <tag>
git push origin <tag>
```
- 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 <tag>"
git push origin main
git tag -f <tag>
git push --force origin <tag>
```
- Generate release with _gren_
```shell
npx github-release-notes@0.17.1 release --tags <tag>
```

41
RELEASE.md Normal file
View file

@ -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 <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
- Tag and push the repo
```shell
git tag --message "" <tag>
git push origin <tag>
```
- 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 <tag>"
git push origin main
git tag --message "" --force <tag>
git push --force origin <tag>
```
- Generate release with _gren_
```shell
npx github-release-notes release --tags <tag>
```