Merge pull request #51 from runwaylab/updates

Updates

Author: GrantBirki

README.md

@@ -157,13 +157,24 @@ Now we need to create a `keys/` directory that contains our public/private key p
 
 > Please ensure the `keys/` dir has 700 permissions and your public/private keys have 600 permissions
 
-We also need to create a `creds.env` file which contains a GitHub PAT that is scoped to allow `read` access to `deployments` since our configuration is specifically looking for GitHub deployments. You may also need `repo` permissions on the token as well if your repository is private.
+We also need to create a `creds.env` file which contains a GitHub PAT for using the `github_deployment` event type. This file should be in the same directory as your `docker-compose.yml` file.
 
 ```ini
 # creds.env
 GITHUB_TOKEN=ghp_abcdefg
 ```
 
+At a bare minimum, the PAT will need the following permissions:
+
+- Deployments: **read and write**
+
+However, to unlock the full potential of runway, you will need to give the PAT the following permissions:
+
+- Deployments: **read and write**
+- Pull Requests: **read and write** (for usage with [`github/branch-deploy`](https://github.com/github/branch-deploy))
+
+You should be using fine-grained GitHub Access Tokens as you can apply granular permissions to them.
+
 Now we can fire up runway!
 
 ```bash

acceptance/logs/expected.log

@@ -3,7 +3,7 @@ INFO: 📖 loading runway configuration
 DEBUG: attempting to load config from acceptance/config/config.yml
 INFO: ✅ loaded configuration successfully
 INFO: 🚚 2 projects loaded
-INFO: 🛫 starting runway - version: v0.3.0
+INFO: 🛫 starting runway - version: v0.4.0
 INFO: 📦 starting project project-1
 INFO: 🕐 scheduling event with interval 3s for project-1
 INFO: 📦 starting project project-2

shard.yml

@@ -1,5 +1,5 @@
 name: runway
-version: 0.3.0
+version: 0.4.0
 
 authors:
   - GrantBirki

src/version.cr

@@ -1,3 +1,3 @@
 module Runway
-  VERSION = "v0.3.0"
+  VERSION = "v0.4.0"
 end