Add Docker support for easier setup (#167)

Co-authored-by: Oleksandr Redko <oleksandr.red+github@gmail.com>

Author: Ketbome

.dockerignore

@@ -0,0 +1,29 @@
+.git
+.gitignore
+
+/output/
+repos/
+git-cache/
+
+.env
+.env.local
+
+*.md
+!README.md
+screenshots/
+
+.github/
+
+.vscode/
+.idea/
+*.swp
+*.swo
+
+.DS_Store
+Thumbs.db
+
+*_test.go
+testdata/
+
+tools/
+Makefile

.env.example

@@ -0,0 +1,16 @@
+# Copy this file to .env and fill in your real information.
+
+# GitLab instance URL.
+# See https://stackoverflow.com/questions/58236175/what-is-a-gitlab-instance-url-and-how-can-i-get-it.
+# For self-hosted GitLab, use your company's URL, like: https://gitlab.yourcompany.com.
+GITLAB_BASE_URL=https://gitlab.com
+
+# GitLab personal access token with scopes: read_api, read_user, read_repository.
+# See https://gitlab.com/-/user_settings/personal_access_tokens.
+GITLAB_TOKEN=<your_gitlab_token_here>
+
+# Your GitHub name with surname.
+COMMITTER_NAME="John Doe"
+
+# Your GitHub email.
+COMMITTER_EMAIL=john.doe@example.com

.github/workflows/build.yml

@@ -21,10 +21,27 @@ jobs:
           go-version: 'stable'
           check-latest: true
 
+      - uses: docker/setup-buildx-action@v3
+
       - run: go mod tidy -diff
 
       - run: go mod download
 
       - run: go mod verify
 
       - run: go build -o /dev/null ./...
+
+  docker:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: docker/setup-buildx-action@v3
+
+      - run: docker build --progress=plain -t github.com/alexandear/import-gitlab-commits:ci .
+
+      - name: Smoke test binary
+        run: |
+          docker run --rm github.com/alexandear/import-gitlab-commits:ci --help

.github/workflows/test.yml

@@ -23,6 +23,16 @@ jobs:
           go-version: 'stable'
           check-latest: true
 
-      - run: go test -v -count=1 -race -shuffle=on -cover ./...
+      - name: Install binary
+        run: go install
 
-      - run: go test -tags=integration -run=TestGitLab -shuffle=on -count=1 -race -v ./...
+      - name: Smoke tests
+        run: |
+          import-gitlab-commits -h
+          import-gitlab-commits --help
+
+      - name: Unit tests
+        run: go test -v -count=1 -race -shuffle=on -cover ./...
+
+      - name: Integration tests
+        run: go test -tags=integration -run=TestGitLab -shuffle=on -count=1 -race -v ./...

.gitignore

@@ -4,3 +4,4 @@ bin/
 repo\.*
 \.vscode
 \.env
+/output

Dockerfile

@@ -0,0 +1,22 @@
+FROM golang:1.24-alpine AS builder
+
+WORKDIR /app
+
+COPY go.mod go.sum ./
+RUN go mod download
+
+COPY . .
+
+RUN CGO_ENABLED=0 GOOS=linux go build -ldflags="-s -w" -trimpath -o import-gitlab-commits
+
+FROM alpine:latest
+
+WORKDIR /root/
+
+RUN apk --no-cache add git ca-certificates
+
+COPY --from=builder /app/import-gitlab-commits /usr/local/bin/import-gitlab-commits
+
+RUN chmod +x /usr/local/bin/import-gitlab-commits
+
+ENTRYPOINT ["import-gitlab-commits"]

Makefile

@@ -18,6 +18,22 @@ build:
 	@echo build
 	@go build -o $(GOBIN)/import-gitlab-commits
 
+.PHONY: docker-build
+docker-build:
+	@echo docker-build
+	@docker build -t github.com/alexandear/import-gitlab-commits .
+
+.PHONY: docker-run
+docker-run: docker-build
+	@echo docker-run
+	@docker run --rm \
+		-e GITLAB_BASE_URL="${GITLAB_BASE_URL}" \
+		-e GITLAB_TOKEN="${GITLAB_TOKEN}" \
+		-e COMMITTER_NAME="${COMMITTER_NAME}" \
+		-e COMMITTER_EMAIL="${COMMITTER_EMAIL}" \
+		-v $$(pwd)/output:/root \
+		github.com/alexandear/import-gitlab-commits
+
 .PHONY: test
 test:
 	@echo test

README.md

@@ -28,6 +28,52 @@ After:
 
 ## Getting Started
 
+You can run the tool with Docker or a native Go build.
+
+## Docker Usage
+
+Run the tool using Docker Compose:
+
+1. Copy the environment variables template:
+
+    ```shell
+    cp .env.example .env
+    ```
+
+2. Edit `.env` and configure your credentials.
+
+3. Build and run with [Docker Compose](https://docs.docker.com/compose/install/):
+
+    ```shell
+    docker compose up
+    ```
+
+The imported repository will be created in the `output/` directory.
+
+### Docker Build Only
+
+If you prefer plain Docker:
+
+Build:
+
+    ```shell
+    docker build -t github.com/alexandear/import-gitlab-commits .
+    ```
+
+Run:
+
+    ```shell
+    docker run --rm \
+        -e GITLAB_BASE_URL="https://gitlab.com" \
+        -e GITLAB_TOKEN="<your_gitlab_token>" \
+        -e COMMITTER_NAME="John Doe" \
+        -e COMMITTER_EMAIL="john.doe@example.com" \
+        -v $(pwd)/output:/root \
+        github.com/alexandear/import-gitlab-commits
+    ```
+
+### Using native Go build
+
 1. Download and install [Go](https://go.dev/dl/).
 2. Install the program by running the following command in a shell:
 
@@ -38,22 +84,25 @@ After:
 3. Set environment variables and run `import-gitlab-commits`:
 
     ```shell
-    export GITLAB_BASE_URL=<your_gitlab_server_url>
+    export GITLAB_BASE_URL=https://gitlab.com
     export GITLAB_TOKEN=<your_gitlab_token>
-    export COMMITTER_NAME="<Name Surname>"
-    export COMMITTER_EMAIL=<mail@example.com>
-
+    export COMMITTER_NAME="John Doe"
+    export COMMITTER_EMAIL=john.doe@example.com
+ 
     $(go env GOPATH)/bin/import-gitlab-commits
     ```
 
-Where:
+Where `$(go env GOPATH)/bin/` is the path where `import-gitlab-commits` is installed.
+
+## Configuration
+
+Configure the tool with these environment variables:
 
-- `GITLAB_BASE_URL` is a GitLab [instance URL](https://stackoverflow.com/questions/58236175/what-is-a-gitlab-instance-url-and-how-can-i-get-it),
+- `GITLAB_BASE_URL` - a GitLab [instance URL](https://stackoverflow.com/questions/58236175/what-is-a-gitlab-instance-url-and-how-can-i-get-it),
 e.g., `https://gitlab.com`, `https://gitlab.gnome.org`, or any GitLab server.
-- `GITLAB_TOKEN` is a personal [access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#create-a-personal-access-token).
-- `COMMITTER_NAME` is your GitHub name with surname, e.g., `John Doe` (can be passed to `git config user.name`).
-- `COMMITTER_EMAIL` is your GitHub email, e.g., `john.doe@example.com` (valid for `git config user.email`).
-- `$(go env GOPATH)/bin/` is the path where `import-gitlab-commits` is installed.
+- `GITLAB_TOKEN` - a personal [access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#create-a-personal-access-token) with these scopes: `read_api`, `read_user`, `read_repository`.
+- `COMMITTER_NAME` - your GitHub name with surname, e.g., `John Doe` (can be passed to `git config user.name`).
+- `COMMITTER_EMAIL` - your GitHub email, e.g., `john.doe@example.com` (valid for `git config user.email`).
 
 ## Internals
 

docker-compose.yml

@@ -0,0 +1,14 @@
+services:
+  import-gitlab-commits:
+    build: .
+    container_name: import-gitlab-commits
+    env_file:
+      - .env
+    environment:
+      - GITLAB_BASE_URL=${GITLAB_BASE_URL:-https://gitlab.com}
+      - GITLAB_TOKEN=${GITLAB_TOKEN}
+      - COMMITTER_NAME=${COMMITTER_NAME}
+      - COMMITTER_EMAIL=${COMMITTER_EMAIL}
+    volumes:
+      - ./output:/root
+    restart: "no"

main.go

@@ -3,6 +3,7 @@ package main
 import (
 	"context"
 	"errors"
+	"flag"
 	"fmt"
 	"log"
 	"net/url"
@@ -14,6 +15,23 @@ import (
 
 const (
 	runTimeout = 10 * time.Minute
+
+	helpText = `Import GitLab Commits
+
+Imports commits from a private GitLab repository to a separate repository.
+
+Usage:
+  import-gitlab-commits [flags]
+
+Flags:
+  -h, --help    Show help message
+
+Environment Variables:
+  GITLAB_BASE_URL     GitLab instance URL (e.g., https://gitlab.com)
+  GITLAB_TOKEN        GitLab personal access token (scopes: read_api, read_user, read_repository)
+  COMMITTER_NAME      Your full name (e.g., John Doe)
+  COMMITTER_EMAIL     Your email (e.g., john.doe@example.com)
+`
 )
 
 func Execute(logger *log.Logger) error {
@@ -53,6 +71,16 @@ func Execute(logger *log.Logger) error {
 }
 
 func main() {
+	help := flag.Bool("help", false, "Show help message")
+	flag.BoolVar(help, "h", false, "Show help message (shorthand)")
+	flag.Parse()
+
+	if *help {
+		_, _ = os.Stdout.WriteString(helpText)
+
+		os.Exit(0)
+	}
+
 	logger := log.New(os.Stdout, "", log.Lshortfile|log.Ltime)
 
 	if err := Execute(logger); err != nil {