feat: switch from make to nox (#73)

* feat: swith from make to nox

* docs: update docstring

* fix: install nox

Author: shenxianpeng

.github/workflows/test.yml

@@ -106,16 +106,13 @@ jobs:
 
     - name: Install Dependencies
       run: |
-        sudo apt-get update
-        sudo apt-get install -y gnuplot
+        pip install nox
+        nox -s install-deps
 
     - name: Generate GitStats Report
       run: |
-        python3 -m venv venv
-        source venv/bin/activate
-        # for testing
-        pip install .
-        gitstats . gitstats-report -f json
+        pip install nox
+        nox -s build
 
     - name: Save GitStats Report
       if: ${{ matrix.python-version == '3.9' }}

.gitpod.yml

@@ -6,5 +6,8 @@
 
 tasks:
   - name: Install & Build
-    init: make install-deps && make build
-    command: make preview
+    init: |
+      pip install nox
+      nox -s install-deps
+      nox -s build
+    command: nox -s preview

Makefile

@@ -0,0 +1,53 @@
+import nox
+import shutil
+from pathlib import Path
+
+# Default tag for docker images
+TAG = "latest"
+
+
+@nox.session
+def image(session: nox.Session) -> None:
+    """Build docker image"""
+    session.run("docker", "build", "-t", f"gitstats:{TAG}", ".", external=True)
+
+
+@nox.session
+def publish_image(session: nox.Session) -> None:
+    """Publish docker image to ghcr"""
+    image(session)  # Build the image first
+    session.run(
+        "docker",
+        "tag",
+        f"gitstats:{TAG}",
+        f"ghcr.io/shenxianpeng/gitstats:{TAG}",
+        external=True,
+    )
+    session.run("docker", "push", f"ghcr.io/shenxianpeng/gitstats:{TAG}", external=True)
+
+
+@nox.session(name="install-deps")
+def install_deps(session: nox.Session) -> None:
+    """Install gnuplot"""
+    session.run("sudo", "apt", "update", "-y", external=True)
+    session.run("sudo", "apt", "install", "gnuplot", "-y", external=True)
+
+
+@nox.session
+def build(session: nox.Session) -> None:
+    """Generate gitstats report and json file"""
+    report_dir = Path("test-report")
+    if report_dir.exists():
+        shutil.rmtree(report_dir)
+    session.install("--upgrade", "pip")
+    session.install("-e", ".")
+    session.run("gitstats", ".", str(report_dir), "-f", "json", external=True)
+
+
+@nox.session
+def preview(session: nox.Session) -> None:
+    """Preview gitstats report in local"""
+    build(session)  # Generate report first
+    session.run(
+        "python3", "-m", "http.server", "8000", "-d", "test-report", external=True
+    )