Improvements to docker setup (#332)

docker/Dockerfile

@@ -1,6 +1,3 @@
-# Build command: `docker build -t sqren/backport .`
-# Publish: docker push sqren/backport
-
 FROM node:latest
 
 RUN mkdir /app
@@ -9,5 +6,5 @@ WORKDIR /app
 COPY ./entrypoint.sh /entrypoint.sh
 
 RUN npm install backport -g
-ENTRYPOINT ["/entrypoint.sh"]
+ENTRYPOINT ["/forward-args-to-backport.sh"]
 CMD []

docker/README.md

@@ -0,0 +1,41 @@
+# Using the docker image
+
+### Running the published image
+
+```
+docker run -it --rm -v $(pwd):/app:ro -v ~/.backport:/root/.backport sqren/backport "$@"
+```
+
+### Running from source
+
+```
+yarn docker-run
+```
+
+# Development
+
+### Build docker image
+
+```
+docker build -t sqren/backport .
+```
+
+### Test image locally before publishing:
+
+```
+docker run -it --rm -v $(pwd):/app:ro -v ~/.backport:/root/.backport sqren/backport "$@"
+```
+
+### Publish to Docker hub
+
+```
+docker push sqren/backport
+```
+
+## Authenticate with docker hub
+
+```
+docker login
+```
+
+A personal access token can be created [here](https://hub.docker.com/settings/security)

docker/backport.sh → docker/build-and-run-dockerfile.sh

@@ -9,5 +9,4 @@
 # "$@": pass all bash arguments to docker (which into turn passes them to backport cli inside container)
 
 cd $(dirname $0)
-docker run -it --rm --name backport -v $(pwd):/app:ro -v ~/.backport:/root/.backport $(docker build -q .) "$@"
-
+docker run -it --rm -v $(pwd):/app:ro -v ~/.backport:/root/.backport $(docker build --tag backport -q .) "$@"

docker/forward-args-to-backport.sh

@@ -0,0 +1,4 @@
+# This file is only needed to forward arguments to backport inside docker
+
+#!/bin/bash
+backport "$@"

package.json

@@ -34,7 +34,7 @@
     "test-mutation": "jest --config ./jest.config.mutation.js",
     "test-private": "jest --config ./jest.config.private.js",
     "test": "jest",
-    "docker-run": "./docker/backport.sh"
+    "docker-run": "./docker/build-and-run-dockerfile.sh"
   },
   "lint-staged": {
     "*.ts": [