Release v2.0.0: The Traffic Update 🚀
This major release transforms the project from a simple clone-tracker into a comprehensive GitHub Traffic Archiver. We now support both Clones and Views, and we've improved the data structure to be future-proof.
⚠️ Breaking Changes
-
CSV Structure Update: The CSV format has changed from 4 columns to 5 columns to accommodate multiple metric types.
-
Old:
date,repository,clones,uniques -
New:
date,repository,type,count,uniques -
Repository Rename: The action is now officially groda/github-traffic-archiver/.github/workflows/metrics.yml@v2). Please update your workflow files to point to the new repository path.
✨ New Features
- Views Tracking: The action now records daily "Views" (page hits) alongside clones.
- Normalization: Introduced a
typecolumn. This allows the action to recordclones,clones_total,views, andviews_totalin a single unified file. - Auto-Migration: The action now includes a built-in check that detects old 4-column CSV files and automatically migrates them to the new 5-column format without losing your history.
🛠 Improvements
- Smart Deduplication: The deduplication logic now handles multiple data types for the same date, ensuring no data is lost when merging clones and views.
- Better Sorting: Files are automatically sorted by date (descending) and grouped by type.
📦 How to Upgrade
Update your GitHub Action workflow file (.github/workflows/metrics.yml):
- name: Record Metrics
uses: groda/github-traffic-archiver/.github/workflows/metrics.yml@v2 # Update this line
with:
observed-repo: ${{ github.repository }}
metrics-repo: your-username/metrics-storage