Update USER_GUIDE and GET.md

Describes the new feature for release_notes and why the new permissions are required. Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
alexellis · Nov 1, 2019 · d3105fe · d3105fe
1 parent ac68a85
commit d3105fe
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/GET.md b/GET.md
@@ -70,8 +70,9 @@ Enter these OAuth Permissions/Scopes:
 - Pull requests - read/write
 - Repository metadata - read only
 
-If you are setting this up on a private repository you need to grant derek permissions to download content, this is so that he can download the config file you'll create:
-- Repository contents - read only
+If you are setting this up on a private repository you need to grant Derek permissions to download content, this is so that he can download the config file. The write permissions are so that Derek can update your release notes if you are using the `release_notes` feature.
+
+- Repository contents - read/write
 
 Subscribe to these events:
 

diff --git a/USER_GUIDE.md b/USER_GUIDE.md
@@ -24,10 +24,27 @@ features:
  - comments
  - pr_description_required
  - hacktoberfest
+ - release_notes
 ```
 
 This file enables Derek usage for `rgee0` and `alexellis`, it also turns on all features available. If you specifically do not want the commenting or `dco_check` feature then comment out the line or remove it from your file. At least one feature is required for Derek to be of use.
 
+### Feature: `release_notes`
+
+Derek will collate closed PRs since the last release and then put together a summary and set it for your release text body.
+
+Example from [openfaas/faas-cli](https://github.com/openfaas/faas-cli/releases/tag/0.9.5):
+
+```
+Changelog for 0.9.5:
+
+PR #709 Fix issue with cloud seal command by @viveksyngh
+PR #707 Add unit test for secrets in forbidden namespace by @viveksyngh
+PR #675 Feature: Add flags for new command to input cpu/memory by @alexellis
+PR #681 Propagate the copy error in call stack by @viveksyngh
+Generated by Derek
+```
+
 ### Feature: `dco_check`
 
 If `dco_check` is specified in the feature list then Derek will inform you when a PR is submitted with commits which have no sign-off message. This is required if your project requires the [Developer Certificate of Origin](https://developercertificate.org).