Skip to content

Releases: jansitarski/gh-activity-badge

v1.0.1 - Fix Template Packaging

Choose a tag to compare

@jansitarski jansitarski released this 01 May 18:45
8e344d1

🐛 Bug Fixes

  • Fixed template packaging: Template files (.j2) are now correctly included in the package distribution
  • This fixes the TemplateNotFound error when using the action

📦 Changes

  • Added [tool.setuptools.package-data] configuration to pyproject.toml
  • Bumped version from 1.0.0 to 1.0.1

🔄 Upgrading

Update your workflow to use @v1.0.1 or continue using @v1 (which will automatically use the latest v1.x.x release):

- uses: jansitarski/gh-activity-badge@v1.0.1
  # or
- uses: jansitarski/gh-activity-badge@v1

v1.0.0 - Initial Release

Choose a tag to compare

@jansitarski jansitarski released this 01 May 18:00
14716c3

GitHub Stats Badge Generator v1.0.0

The first stable release of GitHub Stats Badge Generator - a GitHub Action and standalone tool to create beautiful, animated SVG badges displaying your GitHub statistics.

✨ Features

  • Beautiful Design: Modern, animated SVG with smooth entrance effects
  • Dark/Light Mode: Automatically adapts to user's system preferences
  • Private Repo Support: Include statistics from your private repositories
  • Minimal Dependencies: Only requires Jinja2 for SVG template rendering
  • 6 Key Metrics:
    • 📦 Public Repositories
    • 🔒 Private Repositories
    • 🤝 Contributed Repositories
    • ✅ Merged Pull Requests
    • 📝 Total Commits
    • ➕ Lines Added
  • Automated Updates: Runs on GitHub Actions schedule
  • Customizable: Configure output path, markers, and more

🚀 Quick Start

name: Update GitHub Stats Badge

on:
  schedule:
    - cron: '0 0 * * 1'  # Weekly
  workflow_dispatch:

permissions:
  contents: write

jobs:
  update-stats:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: jansitarski/gh-activity-badge@v1
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
      - uses: stefanzweifel/git-auto-commit-action@v5
        with:
          commit_message: 'chore: update GitHub stats badge'
          file_pattern: 'gh_stats.svg README.md'

📋 Requirements

  • Python 3.9 or higher
  • GitHub token with repo and read:user scopes (for private repo stats)
  • Workflow needs contents: write permission

🔧 Technical Details

  • Zero external dependencies (uses stdlib for HTTP/JSON)
  • Type-safe with mypy type checking
  • Tested with 57 comprehensive unit tests
  • Clean code passing ruff linting
  • Python 3.9+ compatible

📚 Documentation

Full documentation available in the README

🙏 Acknowledgments

Built with Python and Jinja2, using GitHub's GraphQL and REST APIs.


Install: pip install git+https://github.com/jansitarski/gh-activity-badge.git@v1.0.0
Use in Actions: jansitarski/gh-activity-badge@v1