The sixth revision (#55)

Author: habedi

.dockerignore

@@ -0,0 +1,44 @@
+# Version control
+.git
+.gitignore
+
+# Binaries and build artifacts
+bin/
+*.exe
+*.out
+*.test
+
+# IDE/editor junk
+*.swp
+*.swo
+*.bak
+*.tmp
+*.DS_Store
+.vscode/
+.idea/
+
+# Dependency directories
+vendor/
+
+# Go test cache
+*.coverprofile
+*.cov
+coverage.out
+
+# Logs
+*.log
+
+# OS junk
+Thumbs.db
+
+# Other unneeded files and directories
+*.csv
+*.json
+*.zip
+pyproject.toml
+requirements.txt
+Dockerfile
+.venv/
+games/
+tmp/
+temp/

.github/workflows/release.yml

@@ -10,14 +10,14 @@ permissions:
   contents: read
 
 jobs:
-  call_tests:
-    uses: ./.github/workflows/tests.yml
 
   build-windows:
     runs-on: windows-latest
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
+        with:
+          lfs: true
 
       - name: Setup MSYS2 Environment
         uses: msys2/setup-msys2@v2
@@ -55,6 +55,8 @@ jobs:
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
+        with:
+          lfs: true
 
       - name: Set up Go
         uses: actions/setup-go@v5
@@ -85,6 +87,8 @@ jobs:
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
+        with:
+          lfs: true
 
       - name: Set up Go
         uses: actions/setup-go@v5
@@ -109,6 +113,42 @@ jobs:
           name: gogg-macos-arm64
           path: bin/gogg
 
+  build-and-push-docker:
+    runs-on: ubuntu-latest
+    needs: [ build-linux ]
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Log in to the GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract Metadata (Tags and Labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ghcr.io/${{ github.repository }}
+          tags: |
+            type=raw,value=latest
+            type=ref,event=branch
+            type=ref,event=tag
+
+      - name: Build and Push Docker Image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
   release:
     runs-on: ubuntu-latest
     needs: [ build-windows, build-linux, build-macos ]

.github/workflows/tests.yml

@@ -2,7 +2,6 @@ name: Run Tests
 
 on:
   workflow_dispatch:
-  workflow_call:
   pull_request:
     branches:
       - "main"

Dockerfile

@@ -0,0 +1,67 @@
+# ---- Builder Stage ----
+FROM golang:1.24-bookworm as builder
+
+# Install build dependencies
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends \
+        build-essential \
+        pkg-config \
+        libgl1-mesa-dev \
+        libx11-dev \
+        libxcursor-dev \
+        libxrandr-dev \
+        libxinerama-dev \
+        libxi-dev \
+        libxxf86vm-dev \
+        libasound2-dev \
+        ca-certificates \
+        && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /app
+
+# Go module download
+COPY go.mod go.sum ./
+RUN go mod download
+
+# Copy source
+COPY . .
+
+# Build Gogg
+RUN go build -o bin/gogg .
+
+# ---- Final Stage ----
+FROM debian:bookworm-slim
+
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends \
+        libgl1 \
+        libx11-6 \
+        libxcursor1 \
+        libxrandr2 \
+        libxinerama1 \
+        libxi6 \
+        libasound2 \
+        libxxf86vm1 \
+        xvfb \
+        ca-certificates \
+        htop nano duf ncdu \
+        && rm -rf /var/lib/apt/lists/* \
+        && apt-get autoremove -y \
+        && apt-get clean
+
+# Set up directories
+COPY --from=builder /app/bin/gogg /usr/local/bin/gogg
+COPY scripts/docker-entrypoint.sh /usr/local/bin/docker-entrypoint.sh
+RUN chmod +x /usr/local/bin/docker-entrypoint.sh
+
+# Create a non-root user and group
+RUN addgroup --system gogg && adduser --system --ingroup gogg gogg
+RUN mkdir -p /config /downloads && chown -R gogg:gogg /config /downloads
+
+# Set user and volume
+USER gogg
+VOLUME /config
+VOLUME /downloads
+ENV GOGG_HOME=/config
+
+ENTRYPOINT ["/usr/local/bin/docker-entrypoint.sh"]

Makefile

@@ -4,7 +4,7 @@ BINARY_NAME := $(or $(GOGG_BINARY), $(notdir $(REPO)))
 BINARY := bin/$(BINARY_NAME)
 COVER_PROFILE := coverage.txt
 GO_FILES := $(shell find . -type f -name '*.go')
-EXTRA_TMP_FILES := $(shell find . -type f -name 'gogg_catalogue_*.csv' -o -name '*_output.txt')
+EXTRA_TMP_FILES := $(shell find . -type f -name 'gogg_*.csv' -o -name 'gogg_*.json' -o -name '*_output.txt')
 GO ?= go
 MAIN ?= ./main.go
 ECHO := @echo

README.md

@@ -9,9 +9,6 @@
     <a href="https://github.com/habedi/gogg/actions/workflows/tests.yml">
         <img src="https://img.shields.io/github/actions/workflow/status/habedi/gogg/tests.yml?label=tests&style=flat&labelColor=555555&logo=github" alt="Tests">
     </a>
-    <a href="https://github.com/habedi/gogg/actions/workflows/lints.yml">
-        <img src="https://img.shields.io/github/actions/workflow/status/habedi/gogg/lints.yml?label=linters&style=flat&labelColor=555555&logo=github" alt="Linters">
-    </a>
     <a href="https://github.com/habedi/gogg/actions/workflows/release.yml">
         <img src="https://img.shields.io/github/actions/workflow/status/habedi/gogg/release.yml?label=linux%20build&style=flat&labelColor=555555&logo=linux" alt="Linux Build">
     </a>
@@ -26,14 +23,17 @@
         <img src="https://img.shields.io/badge/docs-latest-3776ab?style=flat&labelColor=555555&logo=readthedocs" alt="Docs">
     </a>
     <a href="https://github.com/habedi/gogg">
-        <img src="https://img.shields.io/badge/license-MIT-007ec6?style=flat&labelColor=555555&logo=open-source-initiative" alt="License">
+        <img src="https://img.shields.io/badge/license-MIT-3776ab?style=flat&labelColor=555555&logo=open-source-initiative" alt="License">
     </a>
     <a href="https://codecov.io/gh/habedi/gogg">
         <img src="https://img.shields.io/codecov/c/github/habedi/gogg?style=flat&labelColor=555555&logo=codecov" alt="Code Coverage">
     </a>
     <a href="https://www.codefactor.io/repository/github/habedi/gogg">
         <img src="https://img.shields.io/codefactor/grade/github/habedi/gogg?style=flat&labelColor=555555&logo=codefactor" alt="CodeFactor">
     </a>
+    <a href="https://github.com/habedi/gogg/pkgs/container/gogg">
+        <img src="https://img.shields.io/github/v/release/habedi/gogg?label=image&logo=docker&logoColor=white&style=flat&color=007ec6" alt="Docker Image">
+    </a>
     <a href="https://github.com/habedi/gogg/releases/latest">
         <img src="https://img.shields.io/github/release/habedi/gogg.svg?style=flat&labelColor=555555&logo=github" alt="Release">
     </a>
@@ -80,10 +80,12 @@ See the [documentation](docs/README.md) for how to install and use Gogg.
 Run `gogg -h` to see the available commands and options.
 
 > [!NOTE]
-> Since version `0.4.1`, Gogg has a GUI besides its command line interface (CLI).
-> The GUI is still in the early stages of development and does not support all the features of the CLI and may have
-> bugs.
-> To start the GUI, run `gogg gui`.
+> * Since version `0.4.1`, Gogg has a GUI besides its command line interface (CLI).
+    > The GUI is still in the early stages of development and does not support all the features of the CLI and may have
+    > bugs.
+    > To start the GUI, run `gogg gui`.
+> * Since version `0.4.2`, there are Docker images available for Gogg.
+    > See the [documentation](docs/README.md#containerization) for more information.
 
 #### Examples
 
@@ -102,8 +104,8 @@ gogg login
 ```
 
 > [!IMPORTANT]
-> You need to have [Google Chrome](https://www.google.com/chrome/) or [Chromium](https://www.chromium.org/) installed on
-> your machine for the first-time authentication.
+> You might need to have [Google Chrome](https://www.google.com/chrome/), [Chromium](https://www.chromium.org/), or
+> [Microsoft Edge](https://www.microsoft.com/edge) browsers installed on your machine for the first-time authentication.
 > So, make sure you have one of them installed and available in your system's PATH.
 
 ##### Syncing the Game Catalogue
@@ -147,6 +149,24 @@ DEBUG_GOGG=false gogg file size 1207658924 --platform=windows --lang=en --dlcs=t
 
 [![asciicast](https://asciinema.org/a/kXMGRUUV149R37IEmZKtTH7nI.svg)](https://asciinema.org/a/kXMGRUUV149R37IEmZKtTH7nI)
 
+### GUI Screenshots
+
+<div align="center">
+  <img alt="Game Library" src="docs/screenshots/v0.4.2/5.png" width="100%">
+</div>
+
+<details>
+<summary>Show more screenshots</summary>
+
+<div align="center">
+  <img alt="File Operations" src="docs/screenshots/v0.4.2/2.png" width="100%">
+  <img alt="Download Games" src="docs/screenshots/v0.4.2/8.png" width="100%">
+  <img alt="About" src="docs/screenshots/v0.4.2/14.png" width="100%">
+  <img alt="Download Progress" src="docs/screenshots/v0.4.2/9.png" width="100%">
+</div>
+
+</details>
+
 ---
 
 ### Contributing