diff --git a/Release-Process.md b/Release-Process.md index 6eec588..73d46cb 100644 --- a/Release-Process.md +++ b/Release-Process.md @@ -40,7 +40,7 @@ NB don't include patch versions in the branch name - successive patch versions f If you don't have one already, go to https://github.com/settings/tokens/new and make one with a funny name, and the **public_repo** scope only. (I think.) -## Update the CHANGELOG and test +## Update the CHANGELOG, update docs and test See https://github.com/weaveworks/scope/compare/latest_release...master for a diff. A starting point for the CHANGELOG entry for this release can be obtained by running a little CLI-fu. (Make sure to have `jq` installed for JSON processing.): @@ -61,6 +61,10 @@ Then sort the lines by feature, bug fix, performance etc. sections. You may find it helpful to look at the original issues of the PRs to see what they are about. Commit and push the CHANGELOG to the release branch. +## Update docs + +Update all version references in the documentation (i.e. under the `site/` directory) to the version being released (e.g. all image versions in the installation docs such as `weaveworks/scope:0.15` ) + ## Test the release * Create a PR for the release branch, merging into `master`