diff --git a/CHANGELOG.md b/CHANGELOG.md index 02f290c971..caeaa9b263 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # Changelog -## v2.4.0 (27/08/2019) +## v2.4.0 (04/09/2019) #### Bug Fixes diff --git a/README.md b/README.md index b0f2ccacab..3e0801e9c1 100644 --- a/README.md +++ b/README.md @@ -24,9 +24,9 @@ Visit the [theme documentation](https://learn.netlify.com/en/) to see what is go Navigate to your themes folder in your Hugo site and use the following commands: -``` -$ cd themes -$ git clone https://github.com/matcornic/hugo-theme-learn.git +```shell +cd themes/ +git clone https://github.com/matcornic/hugo-theme-learn.git ``` Check that your Hugo version is minimum `0.25` with `hugo version`. @@ -39,7 +39,7 @@ Check that your Hugo version is minimum `0.25` with `hugo version`. ## Download old versions (prior to 2.0.0) -If you need old version for compatibility purpose, either download [theme source code from releases](https://github.com/matcornic/hugo-theme-learn/releases) or use the right git tag. For example, with `1.1.0` +If you need old version for compatibility purpose, either download [theme source code from releases](https://github.com/matcornic/hugo-theme-learn/releases) or use the right git tag. For example, with `1.1.0` - Direct download way: https://github.com/matcornic/hugo-theme-learn/archive/1.1.0.zip - Git way: @@ -55,6 +55,43 @@ For both solutions, the documentation is available at https://github.com/matcorn Many thanks to [@vjeantet](https://github.com/vjeantet/) for the fork [docdock](https://github.com/vjeantet/hugo-theme-docdock). The v2 of this theme is mainly based on his work ! - ## License + [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn?ref=badge_large) + +## Releasing + +Somewhat work-in-progress steps to release with [gren](https://github.com/github-tools/github-release-notes) + +- Check all MRs assigned to the milestone are closed or pushed back to another release +- Close the milestone +- Check merged MRs on the milestone have a tag (Bug, Enhancement, etc.) +- Tag and push the repo + + ```shell + git tag + git push origin + ``` + +- Generate CHANGELOG.md with _gren_ + + ```shell + gren changelog --override --generate --tags=all + ``` + +- Fix the date for the current release in CHANGELOG.md +- Add the changelog to git and update the tag + + ```shell + git add CHANGELOG.md + git commit -m "Ship tag " + git push origin master + git tag -f + git push --force origin + ``` + +- Generate release with _gren_ + + ```shell + gren release -t + ```