Releases: groda/github-traffic-archiver
v2.0.1 Migration to Composite Action
Update action.yml
v2.0.0
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-storagev2 (Stable)
Floating tag for all v2.* releases
v1.1.1
📦 Release v1.1.1: Marketplace Launch & Documentation Overhaul
This milestone release officially brings the GitHub Clone Archiver to the GitHub Marketplace! 🚀
GitHub only keeps your traffic data for 14 days. This update ensures that the process of archiving that data forever is easier to set up, better documented, and more discoverable for the community.
🌟 What’s New
- Marketplace Integration: Officially listed as a GitHub Action! You can now find and track the project via the GitHub Actions directory.
- Enhanced Data Sorting: Refined the 14-day rolling total logic. By using the tilde (
~) inYYYY-MM-DD~ 14-day total, your summary records now stay perfectly sorted at the top of each day's entries. - New Visual Guides: Added step-by-step screenshots (
PAT.png) to make setting up Personal Access Tokens and permissions foolproof.
🛠 Improvements & Fixes
- README Clarity: Standardized all instructions to use universal placeholders (
YOUR-USERNAME), making the "copy-paste" setup experience much smoother. - Metadata Optimization: Added
action.ymlto support Marketplace branding and searchability.
🚀 Getting Started
If you are already using @v1, your workflow will continue to work perfectly. To use the latest stable release:
uses: YOUR-USERNAME/YOUR-REPO/.github/workflows/metrics.yml@v1.1.1
v1.1.0
📦 Release v1.1.0: Marketplace Launch & Documentation Overhaul
This milestone release officially brings the GitHub Clone Archiver to the GitHub Marketplace! 🚀
GitHub only keeps your traffic data for 14 days. This update ensures that the process of archiving that data forever is easier to set up, better documented, and more discoverable for the community.
🌟 What’s New
- Marketplace Integration: Officially listed as a GitHub Action! You can now find and track the project via the GitHub Actions directory.
- Enhanced Data Sorting: Refined the 14-day rolling total logic. By using the tilde (
~) inYYYY-MM-DD~ 14-day total, your summary records now stay perfectly sorted at the top of each day's entries. - New Visual Guides: Added step-by-step screenshots (
PAT.png) to make setting up Personal Access Tokens and permissions foolproof. - The "Zen of Automation": Integrated the "Schrödinger’s Runner" philosophy into the documentation—explaining why it’s okay to walk away and let the automation work for you.
🛠 Improvements & Fixes
- README Clarity: Standardized all instructions to use universal placeholders (
YOUR-USERNAME), making the "copy-paste" setup experience much smoother. - Metadata Optimization: Added
action.ymlto support Marketplace branding and searchability.
🚀 Getting Started
If you are already using @v1, your workflow will continue to work perfectly. To use the latest stable release:
uses: YOUR-USERNAME/YOUR-REPO/.github/workflows/metrics.yml@v1.1.0
v1.0.0 - Initial Stable Release
Features
- 3-Repo Architecture: Keeps workflows, source code, and data storage separate.
- Persistent Storage: Bypasses the GitHub 14-day traffic data limit.
- Smart Sorting: Uses tilde (
~) priority to place 14-day summaries above daily stats. - High Security Support: Compatible with "Least Privilege" dual-PAT setups.
- JSON-Synchronized: Timestamps are pulled directly from the API data, not the runner clock.
Setup
See the README for instructions on configuring your METRICS_PAT and setting up the caller workflow.
v1.0.0 - Initial Release
This is version 1.0.0 of the Clone Archiver.
Using the @v1 tag ensures you receive minor bug fixes
automatically without breaking your workflow.