Update README and use secrets for folder outputs (#26)

* update readme and remove output folder req

* cleanup

* final readme cleanup

* cleanup args

Author: gsheni

.github/workflows/daily_collection.yaml

@@ -13,6 +13,7 @@ on:
 
 jobs:
   daily_github_collection:
+    environment: daily
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
@@ -21,16 +22,18 @@ jobs:
       with:
         enable-cache: true
         activate-environment: true
-    - name: Install pip and dependencies
+    - name: Install dependencies
       run: |
-        uv pip install -U pip
         uv pip install .
     - name: Collect GitHub Data
       run: |
-        uv run gitmetrics collect -v -q -t ${{ secrets.GITHUB_TOKEN }} -m -c daily.yaml
+        uv run gitmetrics collect -q \
+          --add-metrics \
+          --config-file daily.yaml \
+          --token ${{ secrets.GITHUB_TOKEN }} \
+          --output-folder ${{ secrets.OUTPUT_FOLDER }}
       env:
         PYDRIVE_CREDENTIALS: ${{ secrets.PYDRIVE_CREDENTIALS }}
-
   alert:
     needs: [daily_github_collection]
     runs-on: ubuntu-latest
@@ -42,9 +45,8 @@ jobs:
       with:
         enable-cache: true
         activate-environment: true
-    - name: Install pip and dependencies
+    - name: Install dependencies
       run: |
-        uv pip install -U pip
         uv pip install .[dev]
     - name: Slack alert if failure
       run: python -m gitmetrics.slack_utils -r ${{ github.run_id }} -c ${{ github.event.inputs.slack_channel || 'sdv-alerts' }}

.github/workflows/daily_summarize.yaml

@@ -13,6 +13,7 @@ on:
 
 jobs:
   summarize:
+    environment: daily
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
@@ -22,14 +23,13 @@ jobs:
       with:
         enable-cache: true
         activate-environment: true
-    - name: Install pip and dependencies
+    - name: Install dependencies
       run: |
-        uv pip install -U pip
         uv pip install .
     - name: Run Summarize
       run: |
         uv run gitmetrics summarize \
-          --input-folder ***REMOVED***
+          --input-folder ${{ secrets.OUTPUT_FOLDER }}
       env:
         PYDRIVE_CREDENTIALS: ${{ secrets.PYDRIVE_CREDENTIALS }}
     - uses: actions/checkout@v4
@@ -60,9 +60,8 @@ jobs:
       with:
         enable-cache: true
         activate-environment: true
-    - name: Install pip and dependencies
+    - name: Install dependencies
       run: |
-        uv pip install -U pip
         uv pip install .[dev]
     - name: Slack alert if failure
       run: |

.github/workflows/lint.yaml

@@ -18,9 +18,8 @@ jobs:
       with:
         enable-cache: true
         activate-environment: true
-    - name: Install pip and dependencies
+    - name: Install dependencies
       run: |
-        uv pip install -U pip
         uv pip install .[dev]
     - name: Run lint checks
       run: uv run invoke lint

.github/workflows/traffic_collection.yaml

@@ -13,6 +13,7 @@ on:
 
 jobs:
   daily_traffic_collection:
+    environment: traffic
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
@@ -21,13 +22,15 @@ jobs:
       with:
         enable-cache: true
         activate-environment: true
-    - name: Install pip and dependencies
+    - name: Install dependencies
       run: |
-        uv pip install -U pip
         uv pip install .
     - name: Collect GitHub Traffic Data
       run: |
-        uv run gitmetrics traffic -v -t ${{ secrets.GH_TRAFFIC_TOKEN }} -c traffic_config.yaml
+        uv run gitmetrics traffic \
+          --config-file traffic_config.yaml \
+          --token ${{ secrets.GH_TRAFFIC_TOKEN }} \
+          --output-folder ${{ secrets.OUTPUT_FOLDER }}
       env:
         PYDRIVE_CREDENTIALS: ${{ secrets.PYDRIVE_CREDENTIALS }}
   alert:
@@ -41,9 +44,8 @@ jobs:
       with:
         enable-cache: true
         activate-environment: true
-    - name: Install pip and dependencies
+    - name: Install dependencies
       run: |
-        uv pip install -U pip
         uv pip install .[dev]
     - name: Slack alert if failure
       run: python -m gitmetrics.slack_utils -r ${{ github.run_id }} -c ${{ github.event.inputs.slack_channel || 'sdv-alerts' }}

.github/workflows/weekly_collection.yaml

@@ -13,6 +13,7 @@ on:
 
 jobs:
   weekly_github_collection:
+    environment: weekly
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
@@ -21,18 +22,23 @@ jobs:
       with:
         enable-cache: true
         activate-environment: true
-    - name: Install pip and dependencies
+    - name: Install dependencies
       run: |
-        uv pip install -U pip
         uv pip install .
     - name: Collect GitHub Data
       run: |
-        uv run gitmetrics collect -v -q -t ${{ secrets.GITHUB_TOKEN }} -m -c weekly.yaml
+        uv run gitmetrics collect -q \
+          --add-metrics \
+          --config-file weekly.yaml \
+          --token ${{ secrets.GITHUB_TOKEN }} \
+          --output-folder ${{ secrets.OUTPUT_FOLDER }}
       env:
         PYDRIVE_CREDENTIALS: ${{ secrets.PYDRIVE_CREDENTIALS }}
     - name: Consolidate GitHub Data
       run: |
-        uv run gitmetrics consolidate -v -c weekly.yaml
+        uv run gitmetrics consolidate \
+          --config-file weekly.yaml \
+          --output-folder ${{ secrets.OUTPUT_FOLDER }}
       env:
         PYDRIVE_CREDENTIALS: ${{ secrets.PYDRIVE_CREDENTIALS }}
   alert:
@@ -46,9 +52,8 @@ jobs:
       with:
         enable-cache: true
         activate-environment: true
-    - name: Install pip and dependencies
+    - name: Install dependencies
       run: |
-        uv pip install -U pip
         uv pip install .[dev]
     - name: Slack alert if failure
       run: python -m gitmetrics.slack_utils -r ${{ github.run_id }} -c ${{ github.event.inputs.slack_channel || 'sdv-alerts' }}