review-AL1

.github/workflows/Pipfile

@@ -10,6 +10,9 @@ pytz = "*"
 python-dateutil = "*"
 
 [dev-packages]
+pytest = "*"
+build = "*"
+twine = "*"
 
 [requires]
 python_version = "3"

.github/workflows/ci.yml

@@ -0,0 +1,52 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [ pipfile-experiment ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test-and-build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10"]  
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install build + test tooling
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[dev]"
+          # build tools
+          python -m pip install build
+
+      - name: Run tests
+        run: |
+          pytest -q
+
+      - name: Build package (sdist & wheel)
+        run: |
+          python -m build
+
+      - name: Upload dist artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: pypet-dist-${{ matrix.python-version }}
+          path: dist/*

.github/workflows/event-logger.yml

@@ -1,54 +1,133 @@
 name: log github events
+
 on:
   push:
-    branches: [main, master, pipfile-experiment]
+    branches: [ main, master, pipfile-experiment ]
   pull_request:
-    types: [opened, closed]
-    branches: [main, master, pipfile-experiment]
+    types: [ opened, closed ]
+    branches: [ main, master, pipfile-experiment ]
+  workflow_dispatch: {}  # allow manual runs so the badge can show status any time
+
+permissions:
+  contents: read
+
+concurrency:
+  group: event-logger-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   log:
     runs-on: ubuntu-latest
     env:
-      PIPENV_PIPFILE: .github/workflows/Pipfile # so this script doesn't use the Pipfile in the root directory
+      # keep using the workflow-local Pipfile so we don't pollute the project env
+      PIPENV_PIPFILE: .github/workflows/Pipfile
       COMMIT_LOG_API: ${{ secrets.COMMIT_LOG_API }}
-      GITHUB_LOGIN: ${{ github.actor }} # github login also available in github.triggering_actor, github.event.sender.login
+      GITHUB_LOGIN: ${{ github.actor }}
       COMMITS: ${{ toJSON(github.event.commits) }}
-      REPOSITORY_URL: ${{ github.repositoryUrl }}
+      REPOSITORY_URL: ${{ github.server_url }}/${{ github.repository }}
       EVENT_TYPE: ${{ github.event_name }}
       EVENT_ACTION: ${{ github.event.action }}
       PR_MERGED: ${{ github.event.pull_request.merged }}
-      PR_CREATED_AT: ${{ github.event.pull_request.created_at}}
-      PR_CLOSED_AT: ${{ github.event.pull_request.closed_at}}
+      PR_CREATED_AT: ${{ github.event.pull_request.created_at }}
+      PR_CLOSED_AT: ${{ github.event.pull_request.closed_at }}
+
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout
+        uses: actions/checkout@v4
         with:
-          fetch-depth: 0 # this is important so git fetches all history.. the actions/checkout by default fetches all history as one commit which throws off stats
-      - uses: actions/setup-python@v3
+          fetch-depth: 0  # needed for accurate stats
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
         with:
-          python-version: "^3.9"
-      - name: Install dependencies
+          python-version: "3.10"
+          cache: pip
+
+      - name: Install dependencies (pipenv in workflow scope)
         run: |
+          set -euo pipefail
           python -m pip install --upgrade pip
-          pip install --user pipenv
-          pipenv --python $(which python)
+          python -m pip install pipenv
+          pipenv --python "$(which python)"
           pipenv install
+
+      # --- helpful diagnostics ---
+      - name: Dump GitHub context
+        run: |
+          set -euo pipefail
+          echo "Event:     ${{ github.event_name }}"
+          echo "Action:    ${{ github.event.action }}"
+          echo "Ref:       ${{ github.ref }}"
+          echo "SHA:       ${{ github.sha }}"
+          echo "Actor:     ${{ github.actor }}"
+          echo "Repo:      ${{ github.repository }}"
+          echo '${{ toJson(github.event) }}' > event.json
+          cat event.json | head -c 2000 || true
+
+      # --- event-specific logging ---
       - name: Log pull request opened
         if: github.event_name == 'pull_request' && github.event.action == 'opened'
         run: |
-          pipenv run gitcommitlogger -r $(echo $REPOSITORY_URL) -t pull_request_opened -d $(echo $PR_CREATED_AT) -un $(echo $GITHUB_LOGIN) -o commit_stats.csv -u $(echo $COMMIT_LOG_API) -v
+          set -euo pipefail
+          pipenv run gitcommitlogger \
+            -r "${REPOSITORY_URL}" \
+            -t pull_request_opened \
+            -d "${PR_CREATED_AT}" \
+            -un "${GITHUB_LOGIN}" \
+            -o commit_stats.csv \
+            -u "${COMMIT_LOG_API}" \
+            -v
+
       - name: Log pull request closed and merged
         if: github.event_name == 'pull_request' && github.event.action == 'closed' && github.event.pull_request.merged == true
         run: |
-          echo $COMMITS > commits.json
-          cat commits.json # debugging
-          pipenv run gitcommitlogger -r $(echo $REPOSITORY_URL) -t pull_request_merged -d $(echo $PR_CLOSED_AT) -un $(echo $GITHUB_LOGIN) -i commits.json -o commit_stats.csv -u $(echo $COMMIT_LOG_API) -v
+          set -euo pipefail
+          echo '${{ toJson(github.event.pull_request) }}' > pr.json
+          echo "${COMMITS}" > commits.json
+          pipenv run gitcommitlogger \
+            -r "${REPOSITORY_URL}" \
+            -t pull_request_merged \
+            -d "${PR_CLOSED_AT}" \
+            -un "${GITHUB_LOGIN}" \
+            -i commits.json \
+            -o commit_stats.csv \
+            -u "${COMMIT_LOG_API}" \
+            -v
+
       - name: Log pull request closed without merge
         if: github.event_name == 'pull_request' && github.event.action == 'closed' && github.event.pull_request.merged == false
         run: |
-          pipenv run gitcommitlogger -r $(echo $REPOSITORY_URL) -t pull_request_closed -d $(echo $PR_CLOSED_AT) -un $(echo $GITHUB_LOGIN) -o commit_stats.csv -u $(echo $COMMIT_LOG_API) -v
+          set -euo pipefail
+          pipenv run gitcommitlogger \
+            -r "${REPOSITORY_URL}" \
+            -t pull_request_closed \
+            -d "${PR_CLOSED_AT}" \
+            -un "${GITHUB_LOGIN}" \
+            -o commit_stats.csv \
+            -u "${COMMIT_LOG_API}" \
+            -v
+
       - name: Log push
         if: github.event_name == 'push'
         run: |
-          echo $COMMITS > commits.json
-          cat commits.json # debugging
-          pipenv run gitcommitlogger -r $(echo $REPOSITORY_URL) -t $(echo $EVENT_TYPE) -i commits.json -o commit_stats.csv -u $(echo $COMMIT_LOG_API) -v
+          set -euo pipefail
+          echo "${COMMITS}" > commits.json
+          pipenv run gitcommitlogger \
+            -r "${REPOSITORY_URL}" \
+            -t "${EVENT_TYPE}" \
+            -i commits.json \
+            -o commit_stats.csv \
+            -u "${COMMIT_LOG_API}" \
+            -v
+
+      - name: Upload artifacts
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: event-logger-${{ github.run_number }}
+          path: |
+            event.json
+            pr.json
+            commits.json
+            commit_stats.csv
+          if-no-files-found: ignore

Pipfile

@@ -0,0 +1,14 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+
+[dev-packages]
+pytest-cov = "*"
+codecov = "*"
+coveralls = "*"
+
+[requires]
+python_version = "3.13"