refactor: add dev dockerfile (#365)

- Add dev dockerfile
- Add prod dockerfile 
- Add pubish actions

Author: 0xPoe

.env.example

@@ -1,15 +1,5 @@
-# The ID of your GitHub App.
-APP_ID=
-WEBHOOK_SECRET=development
-
-# Use `trace` to get verbose logging or `info` to show less.
-LOG_LEVEL=debug
-
-# Go to https://smee.io/new set this to the URL that you are redirected to.
-WEBHOOK_PROXY_URL=
-
 # App working port.
-PORT=
+PORT=3100
 
 # Bot database host.
 BOT_DB_HOST=
@@ -22,3 +12,16 @@ BOT_DB_PASSWORD=
 
 # Bot database name.
 BOT_DB_NAME=
+
+# Bot name
+BOT_NAME: ""
+
+# The ID of your GitHub App.
+APP_ID=
+WEBHOOK_SECRET=development
+
+# Use `trace` to get verbose logging or `info` to show less.
+LOG_LEVEL=debug
+
+# Go to https://smee.io/new set this to the URL that you are redirected to.
+WEBHOOK_PROXY_URL=

.github/workflows/publish.yml

@@ -0,0 +1,41 @@
+name: Publish Docker Image
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+jobs:
+  publish:
+    name: Publish
+    runs-on: ubuntu-18.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+      # Generate image tag name, one is with the version number, the other is the latest version.
+      - name: Docker meta
+        id: docker_meta
+        uses: crazy-max/ghaction-docker-meta@v1
+        with:
+          images: ${{ secrets.DOCKERHUB_USERNAME }}/ti-community-bot
+      # The v2 version of docker/build-push-action uses Docker Buildx to build.
+      - name: Docker Setup Buildx
+        uses: docker/setup-buildx-action@v1.1.1
+      - name: Login to Docker Hub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Build and push
+        id: docker_build
+        uses: docker/build-push-action@v2
+        with:
+          push: true
+          context: .
+          file: prod.Dockerfile
+          tags: ${{ steps.docker_meta.outputs.tags }}
+          labels: ${{ steps.docker_meta.outputs.labels }}
+        env:
+          # NOTICE: Do not use the built-in GITHUB_TOKEN, as this will cause the events of other workflows that cannot be triggered.
+          GITHUB_TOKEN: ${{ secrets.CUSTOM_GITHUB_TOKEN }}
+      - name: Image digest
+        run:
+          echo ${{ steps.docker_build.outputs.digest }}

Dockerfile

@@ -16,26 +16,39 @@
 - Docker
 - Docker Compose >= 3
 
-## Setup
+## Development
 
 ```sh
-# Install dependencies
-npm install
+# Copy .env.example to .env (fill in the relevant environment variables)
+copy .env.example .env
 
-# Run with hot reload
-npm run build:watch
+# docker-compose up the db and bot
+docker-compose -f dev.docker-compose.yml up -d --build
+```
+
+### Changing code
+
+The directory is mounted directly into the bot Docker container, which means that the nodemon live-reload server will still just work.
+
+If you change some configuration files or environment variables, we need to restart the service to take effect.
 
-# Compile and run
-npm run build
-npm run start
+```sh
+# Rebuild bot Docker image
+docker-compose -f dev.docker-compose.yml build bot
+
+# Restart running frontend container (if it's already running)
+docker-compose -f dev.docker-compose.yml stop bot
+docker-compose -f dev.docker-compose.yml rm bot
+docker-compose -f dev.docker-compose.yml up -d
 ```
 
 ## Deploy
 
-```sh
-# Docker compose up
-docker-compose up -d --build
+Deploy using the docker-compose file of the production environment.
 
+```sh
+# docker-compose up the bot
+docker-compose -f prod.docker-compose.yml up -d
 ```
 
 ## Contributing

README.md

@@ -0,0 +1,17 @@
+FROM node:14-alpine
+
+WORKDIR /usr/src/app
+
+COPY package*.json ./
+
+RUN apk --no-cache --virtual build-dependencies add \
+    python \
+    make \
+    g++
+
+RUN npm install
+
+COPY . ./
+
+EXPOSE 3000
+CMD ["npm", "run", "dev"]

dev.Dockerfile

@@ -14,5 +14,20 @@ services:
     volumes:
       - ./init.sql:/data/application/init.sql
       - mysql-data:/var/lib/mysql
+  ti-community-bot:
+    build:
+      context: .
+      dockerfile: dev.Dockerfile
+    restart: always
+    entrypoint: npm run dev
+    depends_on:
+      - db
+    links:
+      - db
+    ports:
+      - 3100:3100
+    volumes:
+      # Mount the directory so live reload works.
+      - .:/usr/src/app
 volumes:
   mysql-data:

docker-compose.yml dev.docker-compose.ymldocker-compose.yml renamed to dev.docker-compose.yml

@@ -0,0 +1,28 @@
+FROM node:14-alpine as builder
+
+WORKDIR /usr/src/app
+
+COPY package*.json ./
+
+RUN apk --no-cache --virtual build-dependencies add \
+    python \
+    make \
+    g++
+
+RUN npm install
+
+FROM node:14-alpine as app
+
+WORKDIR /usr/src/app
+
+COPY --from=builder /usr/src/app/node_modules/ ./node_modules/
+
+COPY . ./
+RUN rm -rf /usr/src/app/lib
+
+RUN npm run build
+
+ENV NODE_ENV="production"
+EXPOSE 3100
+
+CMD [ "npm", "start" ]

prod.Dockerfile

@@ -0,0 +1,19 @@
+version: '3'
+
+services:
+  ti-community-bot:
+    image: ti-community-bot:latest
+    environment:
+      PORT: "3100"
+      BOT_DB_HOST: ""
+      BOT_DB_PORT: ""
+      BOT_DB_PASSWORD: ""
+      BOT_DB_NAME: ""
+      BOT_NAME: ""
+      WEBHOOK_PROXY_URL: ""
+      APP_ID: ""
+      PRIVATE_KEY: ""
+    entrypoint: npm start
+    ports:
+      - 3100:3100
+    restart: always