feat: docker build workflow (#308)

feat: build and publish container image

Author: sammcj

.github/workflows/build-docker-image.yml

@@ -0,0 +1,75 @@
+name: Build & Publish Docker Image
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+      - main
+
+permissions:
+  packages: write
+  contents: read
+
+env:
+  IMAGE_NAME: ${{ github.repository }}
+  REGISTRY: ghcr.io
+
+jobs:
+  build:
+    timeout-minutes: 15
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Generate Docker Metadata
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          images: |
+            ghcr.io/${{ github.actor }}/${{ github.repository }}
+          tags: |
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Set up QEMU To support build amd64 and arm64 images
+        uses: docker/setup-qemu-action@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Login to the Github Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v3
+        id: docker_build
+        with:
+          push: ${{ github.event_name != 'pull_request' && ( github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master' ) }}
+          context: .
+          platforms: linux/amd64,linux/arm64
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+      - name: Output image, digest and metadata to summary
+        run: |
+          {
+          echo imageid: "${{ steps.docker_build.outputs.imageid }}"
+          echo digest: "${{ steps.docker_build.outputs.digest }}"
+          echo labels: "${{ steps.meta.outputs.labels }}"
+          echo tags: "${{ steps.meta.outputs.tags }}"
+          echo version: "${{ steps.meta.outputs.version }}"
+          } >> "$GITHUB_STEP_SUMMARY"

.github/workflows/python-app.yml renamed to .github/workflows/build-test.yml

@@ -1,9 +1,10 @@
 # This workflow will install Python dependencies, run tests and lint with a single version of Python
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-name: Python application
+name: Build and Test Python Package
 
 on:
+  workflow_dispatch:
   push:
     branches: [ "master" ]
   pull_request:
@@ -14,9 +15,7 @@ permissions:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
-
     steps:
     - uses: actions/checkout@v3
     - uses: actions/setup-python@v3

.github/workflows/lint-docker.yml

@@ -0,0 +1,26 @@
+name: "Lint Dockerfile"
+
+on:
+  pull_request:
+    paths:
+      - "**/Dockerfile.*"
+      - "**/docker-compose.*"
+    branches:
+      - main
+      - master
+  workflow_dispatch:
+
+jobs:
+  hadolint:
+    name: "Lint Docker with hadolint"
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # tag=v3
+      - name: run tflint
+        uses: reviewdog/action-hadolint@master
+        with:
+          github_token: ${{ secrets.github_token }}
+          reporter: github-pr-review
+          fail_on_error: "false"
+          level: warning
+          filter_mode: "nofilter" # Optional. Check all files, not just the diff

Dockerfile

@@ -1,15 +1,15 @@
 FROM python:2.7
 
-MAINTAINER Simon Toivo Telhaug <[email protected]>
-
 RUN apt-get update \
-&& apt-get install man-db -y
+  && apt-get install man-db -y \
+  && apt-get clean
 
 ADD ./requirements.txt /tmp/requirements.txt
 
 RUN pip install --upgrade pip \
-&& python --version \
-&& pip install -r /tmp/requirements.txt
+  && python --version \
+  && pip install -r /tmp/requirements.txt \
+  && rm -rf ~/.cache/pip/*
 
 ADD ./ /opt/webapp/
 WORKDIR /opt/webapp

README.md

@@ -1,4 +1,4 @@
-## [explainshell.com](http://www.explainshell.com) - match command-line arguments to their help text
+# [explainshell.com](http://www.explainshell.com) - match command-line arguments to their help text
 
 explainshell is a tool (with a web interface) capable of parsing man pages, extracting options and
 explain a given command-line by matching each argument to the relevant help text in the man page.
@@ -72,7 +72,7 @@ INFO:explainshell.store:inserting mapping (alias) echo -> echo (52207a1fa9b52e42
 successfully added echo
 ```
 
-### Start up a local web server:
+### Start up a local web server
 
 ```ShellSession
 $ make serve