feat(ci): build Docker Image on PRs (#382)

* feat(ci): add GitHub Actions workflows for Docker image build and rename PyPI publish * chore: rename cli module to __main__ so it can be executed without having to build * Update .github/workflows/docker_image.yml Co-authored-by: Filip Christiansen <22807962+filipchristiansen@users.noreply.github.com>

Author: NicolasIRAGNE

.github/workflows/docker_image.yml

@@ -0,0 +1,24 @@
+name: Build Docker Image
+
+on:
+ pull_request:
+ branches: [ main ]
+ workflow_dispatch:
+
+jobs:
+ docker:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v4
+
+ - name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v3
+
+ - name: Build
+ uses: docker/build-push-action@v6
+ with:
+ push: false
+ context: .
+ file: Dockerfile
+ tags: "${{ github.sha }}"

.github/workflows/publish.yml renamed to .github/workflows/publish_to_pypi.yml

@@ -44,7 +44,7 @@ dev = [
 ]
 
 [project.scripts]
-gitingest = "gitingest.cli:main"
+gitingest = "gitingest.__main__:main"
 
 [project.urls]
 homepage = "https://gitingest.com"

pyproject.toml

@@ -8,7 +8,7 @@
 import pytest
 from click.testing import CliRunner, Result
 
-from gitingest.cli import main
+from gitingest.__main__ import main
 from gitingest.config import MAX_FILE_SIZE, OUTPUT_FILE_NAME
 
 
@@ -72,8 +72,8 @@ def test_cli_with_stdout_output() -> None:
  # ─── core expectations (stdout) ────────────────────────────────────-
  assert result.exit_code == 0, f"CLI exited with code {result.exit_code}, stderr: {result.stderr}"
  assert "---" in result.stdout, "Expected file separator '---' not found in STDOUT"
- assert "src/gitingest/cli.py" in result.stdout, (
- "Expected content (e.g., src/gitingest/cli.py) not found in STDOUT"
+ assert "src/gitingest/__main__.py" in result.stdout, (
+ "Expected content (e.g., src/gitingest/__main__.py) not found in STDOUT"
  )
  assert not output_file.exists(), f"Output file {output_file} was unexpectedly created."