Update docs and pipeline (erikengervall#135)

* Run pipeline on PRs * Amend docs for dockestService.commands
n1ru4l · Feb 3, 2020 · 2765b1f · 2765b1f
1 parent feeff5f
commit 2765b1f
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml
@@ -4,7 +4,7 @@ name: Node.js CI
 # tags   refs/tags/v0.0.1
 # master refs/heads/master
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   ####### Print: Prints some context relating to the job to make future debugging easier

diff --git a/docs/api_reference.md b/docs/api_reference.md
@@ -168,12 +168,14 @@ Default: `-`
 
 Service name that matches the corresponding service in your Compose file
 
-### `dockestService.commands` [string[]]
+### `dockestService.commands` [(string | function)[] => string[]]
 
 Default: `[]`
 
 Bash scripts that will run once the service is ready. E.g. database migrations.
 
+Can either be a string, or a function that generates a string. The function is fed the container id of the service.
+
 ### `dockestService.dependents` [DockestService[]]
 
 Default: `[]`