v1.0.4

1.0.0 (2024-11-30)

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog,
and this project adheres to Semantic Versioning.

Migration Guide

Migrating from gayanvoice/top-github-users-action

This guide helps you migrate from the original action (gayanvoice/top-github-users-action) to this modernized version.

Key Differences

• Modernized JavaScript codebase with better reliability
• Improved error handling and logging
• Updated dependencies for better security
• Enhanced documentation and dark mode support
• Maintained same core functionality and data format

Steps to Migrate

1. Update your workflow file from:

# Old workflow
name: Top GitHub Users
on:
  schedule:
    - cron: '0 0 * * *'
jobs:
  main:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: gayanvoice/top-github-users-action@master
        env:
          CUSTOM_TOKEN: ${{ secrets.CUSTOM_TOKEN }}

To:

# New workflow
name: Top GitHub Users
on:
  schedule:
    - cron: '0 0 * * *'
  workflow_dispatch:      # Added for manual triggers
jobs:
  main:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4    # Updated checkout version
      - uses: Zaid-maker/top-github-users-action@v1.0.1
        with:                        # Changed from env to with
          CUSTOM_TOKEN: ${{ secrets.CUSTOM_TOKEN }}

2. Repository Structure:

   • Keep your existing config.json - it's compatible
   • Keep your existing documentation files
   • Keep your existing README.md customizations

3. No Data Migration Needed:

   • The output format remains the same
   • Existing statistics will be preserved
   • Generated markdown files are compatible

4. Verify Your Token:

   • Ensure your CUSTOM_TOKEN has required permissions
   • Token needs repo and user scopes
   • Check token expiration

5. Troubleshooting Common Issues:

   • If the action fails, check the detailed error logs
   • Verify your config.json is in the repository root
   • Make sure your repository has Actions enabled
   • Check if the token has sufficient permissions

Need help? Open an issue at: https://github.com/Zaid-maker/top-github-users-action/issues

1.0.3 - 2024-01-15

Fixed

• Config file write operation error handling
• Cross-platform compatibility in build scripts
• GitHub Actions workflow reliability

Added

• Automated release workflow
• Automated changelog generation
• Comprehensive CI/CD pipeline
• Node.js 20.x support
• NPM caching in CI/CD
• Security audit in build process

Changed

• Updated GitHub Actions to latest versions
• Enhanced build artifact handling
• Improved release automation
• Better error reporting in config operations

1.0.2 - 2024-01-15

Fixed

• Config file content access in GitHubUsersMonitor
• Config validation for required sections
• Error messages for config loading
• Path to devMode setting in config

Added

• Better error logging for config issues
• Config file validation checks
• Detailed error messages for troubleshooting

1.0.1 - 2024-01-15

Fixed

• Config file loading in production environment
• Added config.json to dist folder during build
• Improved error logging for config file operations

Changed

• Updated config file path resolution to use process.cwd()
• Enhanced build process to include config.json

1.0.0 - 2024-01-15

Added

• Complete modernization of codebase
• ES Modules support
• Class-based architecture
• Comprehensive error handling
• Enhanced type safety
• Dark mode support in documentation
• Detailed attribution section

Changed

• Updated all dependencies to latest versions
• Improved project structure
• Enhanced documentation
• Better code organization
• Modern JavaScript practices

Updated Dependencies

• @octokit/graphql: 4.6.2 → 7.0.2
• fs-extra: 9.1.0 → 11.1.1
• simple-git: 2.39.0 → 3.19.1
• Node.js requirement: 20.x

Historical Note

This project was originally created by gayanvoice and has been modernized and maintained by Zaid Hafeez. The v1.0.0 release represents a complete modernization of the codebase while maintaining the original functionality.

✅ All tests passed